Pause Subscription Collection
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
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/pauseCollection 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/pauseCollection" \ -H "Content-Type: application/json" \ -d '{}'{ "status": "success", "data": { "success": true }}Cancel Subscription PATCH
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.
End Subscription Trial PATCH
End a Subscription's trial immediately and start the paid subscription. The Subscription must be in trialing status. The first Invoice is created and charged right away using the payment method on file. The outcome (emails, webhooks, orders) is identical to the trial ending naturally. Safe to retry: the same trial is only ever invoiced and charged once. Once the trial has ended, a repeat returns 400.