Pause a subscription for whole periods
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.
/subscriptions/{subscription}/pauseCustomers 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.
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/pause" \ -H "Content-Type: application/json" \ -d '{ "periods": 1 }'{ "subscription_id": "string", "lines": [ { "product_id": "string", "item_ids": [ "string" ] } ], "offer": "skip_period", "periods": 1, "paid_through_at": "2019-08-24T14:15:22Z", "restart_at": "2019-08-24T14:15:22Z", "collection_resumes_at": "2019-08-24T14:15:22Z", "currency": "string", "exposure": 0, "steps": [ { "name": "updateSubscriptionTerms", "args": { "property1": null, "property2": null } } ], "action_hash": "string"}