Revoke a scheduled cancellation
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.
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 whose scheduled cancel to withdraw.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/subscriptions/s_1234567890/revoke_cancellation"{ "success": true}Cancel a subscription POST
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.
Get dunning settings GET
Returns the division's dunning (failed payment recovery) settings. A division that has never configured them returns Bolt's defaults. The retry schedule's shape depends on how the division renews. Divisions renewing by invoice (Bolt Cart) return `retry_schedule_days` and no `final_action`: the subscription pauses after the last failed retry and resumes on its own once the invoice is paid or voided. Divisions renewing by stored card return `retry_schedule_hours` and `final_action`.