Cancel a line that expands to one entire subscription (seller dashboard)
/dashboard/subscriptions/{subscription}/items/{item}/cancelAuthorization
cookieAuth In: cookie
Path Parameters
Opaque subscription ID.
^sbs_[0-7][0-9abcdefghjkmnpqrstvwxyz]{25}$(?![\s\S])Opaque subscription item ID.
^sbi_[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/dashboard/subscriptions/string/items/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"}Cancel a whole subscription now or at period end (seller dashboard) POST
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.
Change a live subscription item quantity (seller dashboard) POST
For active, trialing or past_due subscriptions. Increases and decreases apply immediately using the product proration setting, preserving the billing date. Flat per-unit licensed seats and plain per-unit metered components support renewal notices. Tiered, package, decimal and special-term components, and other unsupported resulting shapes, return notice_unsupported_shape. An unchanged quantity returns 409 quantity_unchanged without an operation. Bill-now changes refuse an unsuccessful immediate payment. Requires a merchant person or key; agent approvals and customer sessions are not supported.