Change a live subscription item quantity (seller dashboard)
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.
/dashboard/subscriptions/{subscription}/items/{item}/quantityFor 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.
Authorization
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/quantity" \ -H "Content-Type: application/json" \ -d '{ "quantity": 0 }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "status": "string", "approval": { "id": "string", "expires_at": "2019-08-24T14:15:22Z" }}Cancel a line that expands to one entire subscription (seller dashboard) POST
Previous Page
Pause a subscription for whole periods (seller dashboard) POST
Customers pause from the billing page when every product allows it; merchants give a reason. Monthly, flexible-billing subscriptions only. No access while paused; the subscription restarts on the restart date with a normal payment. Pauses run to the selected restart date; early resume is unavailable. Customer pause requires both product access_policy.pause_enabled and company customer_self_service.pause (default false). After enabling company pause, customers must sign in again to receive the pause flow; existing sessions do not gain it.