Pause charging
Stops charging without ending the mandate; nothing is billed while it is paused.
/v1/subscriptions/{subscriptionId}/pauseStops charging without ending the mandate; nothing is billed while it is paused. Requires subscriptions:write, and a user token may pause only its own subscription (forbidden, 403). Refuses subscription_not_found (404) and invalid_state (409) when the subscription is not in a state that can be paused. Audited.
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/pause"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "plan_name": "string", "amount": 0, "commission": 0, "interval": "weekly", "status": "active", "next_charge_at": "2019-08-24T14:15:22Z", "retry_count": 0, "metadata": { "property1": "string", "property2": "string" }, "created_at": "2019-08-24T14:15:22Z"}Fetch a subscription
Fetches one subscription with its status, next charge time and retry count.
Resume a paused subscription; the period re-anchors at the resume time
Restarts a paused subscription. The period re-anchors at the resume time, so the subscriber is not billed for the pause and the next charge is a full interval away.