Cancel a whole subscription now or at period end
Customers use product cancellation defaults; differing defaults use period end. Merchants must choose timing. Merchant cancel-now refunds require proven current-period proration and payment evidence. Period-end cancellation releases an attached schedule first, so its later phases do not happen.
/subscriptions/{subscription}/cancelCustomers use product cancellation defaults; differing defaults use period end. Merchants must choose timing. Merchant cancel-now refunds require proven current-period proration and payment evidence. Period-end cancellation releases an attached schedule first, so its later phases do not happen.
Authorization
bearerAuth In: header
Path Parameters
Opaque subscription ID.
^sbs_[0-7][0-9abcdefghjkmnpqrstvwxyz]{25}$(?![\s\S])Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/subscriptions/string/cancel" \ -H "Content-Type: application/json" \ -d '{}'{ "subscription_ids": [ "string" ], "item_ids": [ "string" ], "timing": "now", "steps": [ { "seq": 1, "name": "cancelSubscription", "args": { "property1": null, "property2": null } } ], "action_hash": "string"}