subscriptions
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
PATCH
Path Parameters
Subscription ID or order number
Body
application/json
PATCH /v0/subscriptions/:subscriptionIdOrNumber/pauseCollection Request body
How to handle pending invoices during pause: - void: Void any pending invoices (default) - keep_as_draft: Keep pending invoices as drafts - mark_uncollectible: Mark pending invoices as uncollectible
Available options:
void
, keep_as_draft
, mark_uncollectible
Optional timestamp to automatically resume the Subscription (Unix timestamp in seconds)
Required range:
0 <= x <= 9007199254740991