Subscriptions
API ReferenceSubscriptionsPause
Pause Subscription
Pauses an active subscription. Billing stops while the subscription is paused and resumes when the subscription is unpaused.
POST /subscriptions/{subscription_id}/pause
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | The unique identifier for the subscription. |
Headers
| Header | Type | Required | Description |
|---|---|---|---|
api-key | string | Yes | Your secret API key. |
X-Profile-Id | string | Yes | Profile ID for authentication. |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
pause_option | string | No | When to pause the subscription: immediately, end_of_term, or specific_date. Defaults to immediately if omitted. |
pause_at | string | No | ISO 8601 date when the subscription should be paused. Required when pause_option is specific_date. |
Request Example