A subscription is a resource used to periodically charge a customer. It is created using a transaction token specifically requested for subscription use. Subscriptions can only be created if your account is verified.
Subscription billing will be charged at the interval specified at the time of creation. They can be canceled at any time.
The merchant can set the interval and number of retries for failed subscription payments, and if the payment fails a set number of consecutive times, the recurring billing will be stopped.
A charge is created immediately upon creating a subscription.
It is recommended to use webhooks to be alerted of subscriptions events. The
SUBSCRIPTION_PAYMENT event will notify you when a successful payment has been made. The
SUBSCRIPTION_FAILED event will notify failed payments for a subscription. The
SUBSCRIPTION_CANCELED event will notify you when a subscription has been canceled.
It is possible to update the payment information for a subscription by updating it with a new transaction token. If you update an
unpaid subscription’s transaction token, it will immediately create another charge.
The subscription object
The unique identifier for the subscription
The unique identifier for the store the charge was made to.
The amount to charge.
The currency the charge will be in.
The amount that was requested to be charged formatted to include a decimal place if there is a minor currency unit.
The initial amount to charge
The initial amount that was requested to be charged formatted to include a decimal place if there is a minor currency unit.
The date in which all subsequent payments should start on, in
Year-Month-Day format. The date is in conjunction with the timezone declared in
|string (IANA Timezone)
The timezone the subscription will be charged at
period is month-based (e.g.
semiannually), and the
start_on date provided is the last day of the month, this option allows the charge to follow the end of the month. E.g. If
2018-06-30, then the next charge is
The frequency of the subscription billed. One of
annually. If this field is populated,
cyclical_period will not have a value
|string (ISO-8601 Duration)
The frequency of the subscription expressed as a ISO-8601 duration, with a minimum frequency of 1 day and a minimum interval of 1 day. If this field is populated,
period will not have a value.
fixed_cycles, then this field is required. Specifies the number of cycles, in the installment, has to be 2 or more cycles
Number of payments：3,5,6,10,12,15,18,20,24
fixed_cycles, then this field is required. Specifies the number of cycles, in the subscription plan
fixed_cycle_amount, then this field is required. Specifies the amount per cycle, in the subscription plan
The unique identifier of the scheduled payment
The date this payment will be executed based on the timezone declared in
zone_id. Time is fixed to 9am of the timezone declared in
|string (IANA Timezone)
The timezone in which this payment will be executed at.
The amount to be charged
The currency to be charged in
The amount to be charged formatted to include a decimal place if there is a minor currency unit.
If the payment has been executed
If this is the last payment in the subscription, only applicable for installment type subscription.
The time the scheduled payment was created on
Number of payments left, if applicable.
The amount left, if applicable.
The amount left, if applicable, formatted to include a decimal place if there is a minor currency unit.
The status of the subscription. One of
Any user defined metadata associated with the refund.
The date the refund was created on.