Cancel a subscription
Cancels a subscription by its ID, immediately by default. This cancels any of the subscription's orders that are currently scheduled, paused, or payment_failed; no further orders will be placed.
With "at_period_end": true in the request body the cancel is scheduled for the end of the current billing period instead: the subscription stays active until then, and the pending cancel surfaces as scheduled_change on the subscription until it applies. A scheduled cancel can be withdrawn with revokeCancellation. Scheduling is only supported on subscriptions that renew by invoice; other subscriptions reject it.
Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard. Send it together with X-Publishable-Key.
In: header
Path Parameters
ID of the subscription to cancel.
Query Parameters
Deprecated: send at_period_end in the request body instead. The body value wins when both are sent.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/subscriptions/s_1234567890/cancel" \ -H "Content-Type: application/json" \ -d '{ "at_period_end": true }'{ "success": true}Unpause a subscription POST
Unpauses a previously paused subscription by its ID. This computes the next billing date from the plan's frequency and reschedules the subscription's order. Returns an error if the subscription is not currently paused.
Revoke a scheduled cancellation POST
Withdraws a cancel that was scheduled with `at_period_end=true`. The subscription keeps renewing as if the cancel was never requested. Only subscriptions that renew by invoice support scheduled cancels.