Webhooks

Subscription paused

Sent when a subscription is paused immediately: by you through the API or the dashboard, or by the customer in the portal. A pause scheduled for the end of the period is not announced when it takes effect. Renewals stop until it is resumed; nothing already issued is voided or recalled. data.object is the subscription: id, subscription_id, customer_id, status (paused), previous_status and effective_date. Action required: decide whether the customer keeps access while the subscription is paused. Fetch the subscription for its current state.

Sent when a subscription is paused immediately: by you through the API or the dashboard, or by the customer in the portal. A pause scheduled for the end of the period is not announced when it takes effect. Renewals stop until it is resumed; nothing already issued is voided or recalled. data.object is the subscription: id, subscription_id, customer_id, status (paused), previous_status and effective_date. Action required: decide whether the customer keeps access while the subscription is paused. Fetch the subscription for its current state.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The envelope for all webhook event deliveries. Contains the event type, timestamp, and the affected object in the data field.

Response Body

Example Requests

The envelope for all webhook event deliveries. Contains the event type, timestamp, and the affected object in the data field.

POST/subscription.paused