subscription.updated

Occurs when a customer subscription is updated (e.g., cancel at period end changes).

WEBHOOK subscription.updated

Example

{
  "id": "<string>",
  "status": "<string>",
  "cancelAtPeriodEnd": true,
  "renewalPeriodStart": "2023-11-07T05:31:56Z",
  "renewalPeriodEnd": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "amount": 123,
  "customerId": "<string>",
  "customerEmail": "<string>",
  "customerName": "<string>",
  "productId": "<string>",
  "productTitle": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).

Body

application/json

id · string

The subscription ID.

status · string

Current status of the subscription.

cancelAtPeriodEnd · boolean

renewalPeriodStart · string<date-time> | null

renewalPeriodEnd · string<date-time> | null

currency · string

amount · number

customerId · string | null

customerEmail · string | null

customerName · string | null

productId · string | null

productTitle · string | null

createdAt · string<date-time> | null

updatedAt · string<date-time> | null

Response

200

Webhook processed successfully.