Operations API
Subscriptions

Pause Subscription

This API endpoint (POST) pauses the payment collection of a subscription. If the request succeeds, it returns a Subscription Object. Permissions: subscriptions.edit Webhook event: subscription-updated

Path Parameters

id * The id of the subscription to update.

Body Parameters

pause_behaviour string * The possible values are mark_uncollectible (invoice is treated as bad debt), void (all future invoices will be avoided) and keep_as_draft (temporarily offer services for free and collect payment later).



resume_date date-format The date that the subscription's payment collection will be automatically resumed.