Create a subscription item - WooshPay OpenAPI

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

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"
}