Cancel Subscription
Cancel a Subscription, either immediately or at the end of the current billing period. This endpoint issues no refund; refund the Subscription's payment separately if one is due.
Authorization
Public key Secret key In: header
In: header
Path Parameters
Subscription identifier - the initial order number, exactly as returned in subscription.id. Omit the leading # the dashboard shows: a #-prefixed value passes validation but resolves to nothing. Payment-provider subscription ids are not accepted.
^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$Request Body
application/json
PATCH /v0/subscriptions/:subscriptionIdOrNumber/cancel Request body
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PATCH "https://example.com/v0/subscriptions/ABC123DEF456/cancel" \ -H "Content-Type: application/json" \ -d '{}'{ "status": "success", "data": { "success": true }}Charge Subscription POST
Charge an additional one-off amount to an active Subscription. Creates a new Invoice and handles payment processing. Multiple items (up to 20) can be charged in a single call; each becomes its own Invoice line. All items must share the same currency, and that currency must match the Subscription's currency. Tax is calculated on the total and distributed proportionally across the lines.
Pause Subscription Collection PATCH
Pause a Subscription's payment collection temporarily with options for handling payments. During the pause period: - No charges will be made - Access to subscription benefits will be maintained - Can be resumed manually or automatically at a specified time