WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Subscription Items
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
      POST
    • Retrieve a refund
      GET
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
      POST
    • Retrieve a subscription item
      GET
    • Delete a subscription item
      DELETE
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Subscription Items

Create a subscription item

Developing
POST
/v1/subscription_items

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json
Body Params application/json
metadata
string 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
quantity
integer 
optional
The quantity of the plan to which the customer should be subscribed.
subscription
string 
required
The subscription this subscription_item belongs to.
price_data
object 
optional
Data used to generate a new Price object inline.
currency
string 
required
Three-letter ISO currency code.
product
string 
required
The ID of the product that this price will belong to.
recurring
object 
required
The recurring components of a price such as interval and interval_count.
unit_amount
string 
required
A positive integer in pence (or 0 for a free price) representing how much to charge.
price
string 
optional
The ID of the price object.
Example
{
    "metadata": "string",
    "quantity": 0,
    "subscription": "string",
    "price_data": {
        "currency": "string",
        "product": "string",
        "recurring": {
            "interval": "string",
            "interval_count": "string"
        },
        "unit_amount": "string"
    },
    "price": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://apitest.wooshpay.com/v1/subscription_items' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "metadata": "string",
    "quantity": 0,
    "subscription": "string",
    "price_data": {
        "currency": "string",
        "product": "string",
        "recurring": {
            "interval": "string",
            "interval_count": "string"
        },
        "unit_amount": "string"
    },
    "price": "string"
}'

Responses

🟢200OK
application/json
Body
id
string 
optional
Unique identifier for the object.
object
string 
optional
String representing the object’s type. Objects of the same type share the same value.
metadata
string 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
price
object 
optional
The price the customer is subscribed to.
id
string 
optional
Unique identifier for the object, like "price_xxxx".
object
string 
optional
'price'
active
boolean 
optional
Whether the price can be used for new purchases.
billing_scheme
enum<string> 
optional
Describes how to compute the price per period. Either per_unit or tiered
Allowed values:
per_unittiered
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
currency
string 
optional
Three-letter ISO currency code, in uppercase.
livemode
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
lookup_key
string 
optional
A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
metadata
object 
optional
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
nickname
string 
optional
A brief description of the price, hidden from customers.
product
string 
optional
The ID of the product this price is associated with.
type
enum<string> 
optional
One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
Allowed values:
one_timerecurring
unit_amount
integer 
optional
The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.
recurring
object 
optional
The recurring components of a price
tiers_mode
null 
optional
(未实现)
tiers
array [object {3}] 
optional
(未实现)
quantity
integer 
optional
The quantity of the plan to which the customer should be subscribed.
subscription
string 
optional
The subscription this subscription_item belongs to.
created
string 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
Example
{
    "id": "string",
    "object": "string",
    "metadata": "string",
    "price": {
        "id": "string",
        "object": "string",
        "active": true,
        "billing_scheme": "per_unit",
        "created": 0,
        "currency": "string",
        "livemode": true,
        "lookup_key": "string",
        "metadata": {},
        "nickname": "string",
        "product": "string",
        "type": "one_time",
        "unit_amount": 0,
        "recurring": {
            "interval": "day",
            "interval_count": 0,
            "usage_type": "licensed"
        },
        "tiers_mode": null,
        "tiers": [
            {
                "up_to": "string",
                "flat_amount": "string",
                "unit_amount": "string"
            }
        ]
    },
    "quantity": 0,
    "subscription": "string",
    "created": "string"
}
Previous
List subscriptions
Next
Retrieve a subscription item
Built with