On this page
No Headings
Update request for a subscription.
objectnamestringThe name of the subscription.
start_dateobjectdate-timeDate and time in ISO 8601 format.
The effective start date of the subscription; can be past, current, or future. Date must be provided in ISO 8601 format
end_dateobjectdate-timeDate and time in ISO 8601 format.
The subscription will terminate on this date without renewal. Date must be provided in ISO 8601 format
statusobject"PENDING", "ACTIVE", "TERMINATED", "CANCELED"The status of the subscription
If the status field is not defined and multiple active and pending subscriptions exists, we will update the active subscription. However, if you wish to update a pending subscription, please ensure that you include the status attribute with the pending value in your request body.
plan_overridesobjectamountobjectvaluerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
descriptionstringThe description on the plan
invoice_display_namestringSpecifies the name that will appear on the invoice
namestringThe name of the plan
chargesarrayitemsobjectidrequiredstringUnique identifier of the charge
tax_codesarrayList of unique codes used to identify taxes to be applied.
itemsstringpropertiesobjectPricing thresholds that determine the charges
minimum_commitmentobjectMinimum commitment for this plan.
amountrequiredobjectvaluerequirednumberdecimal0The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
invoice_display_namestringSpecifies the name that will be displayed on an invoice. If no value is set for this field, the default name will be used as the display name.
tax_codesarrayList of unique codes used to identify taxes to be applied.
itemsstringtax_codesarrayList of unique codes used to identify taxes to be applied.
itemsstring