POST /plans

Time	Status	User Agent
Retrieving recent requests…

Query Params

organization-id

string

Specifies the merchant on whose behalf the request is being made. Include this parameter if the request is being performed by a platform organization that is acting on behalf of one of its merchants. Without this parameter, operations initiated by a platform organization will default to being associated with the platform itself.

Body Params

service_id

string

required

name

string

required

description

string

required

type

string

enum

Defines the plan type. Possible values:
• subscription: recurring plan billed according to the interval.
• unique: single-charge plan (one-time payment).

Allowed:

frequency

string

enum

For type = subscription. Possible values:
• day
• week
• month
• quarterly
• semianually
• year

Allowed:

amount

number

required

Amount to be charged per billing cycle.
If subscription_type = fixed, this is the amount to be charged every billing cycle.
If subscription_type = variable, this is unit price amount of the plan.

currency

string

ISO 4217 currency code (e.g. USD, EUR). Determines the currency in which the customer is charged.

billing_cycles

number

Total number of billing cycles. If set, the subscription will automatically end after the specified number of cycles

has_service_activation_date

boolean

Indicates whether billing should be deferred until a product or service is received or confirmed by the customer. Useful when a subscription is created before the service is actually activated.

trial_period_days

number

Number of free trial days before the first charge. Should be a number between 1 and 90. If omitted, billing starts immediately.

external_plan_id

string

subscription_type

string

enum

Defines whether the subscription amount is fixed or can vary per billing cycle. Possible values:
• fixed: the same amount is charged every cycle (default).
• variable: the amount may change across billing cycles (e.g. Quantity/Per-Unit Subscription:).

Allowed:

payment_day

number

Day of the month when the charge should occur (1–31). If omitted, the billing day is based on the subscription start date.

future_charge_action

string

enum

Only if subscription_type=variable. Determines how to handle billing cycles where no consumption is reported:
• no_charge: customer is not charged for the cycle.
• last_charge: customer is charged the same amount as in the last cycle that had consumption.

Allowed:

Headers

api-key

string

organization-id

string

200200

400400

401401