v20

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-214885191.3 KB

Webhooks

Get the webhook event envelope schema

Returns a representative example of the signed webhook payload every endpoint receives. Useful when building and type-checking a webhook handler; the live type will be one of the values from event-types.

get/v1/sdk/webhooks/event-schema

Response

api_versionstring required

API version that produced the event payload.

creatednumber required

Unix timestamp (seconds) when the event was created.

idstring required

Unique event ID.

livemodeboolean required

True for live-mode events, false for sandbox.

type'customer.created' | 'customer.updated' | 'customer.deleted' | 'purchase.created' | 'purchase.activated' | 'purchase.updated' | 'purchase.trial_ending' | 'purchase.trial_converted' | 'purchase.suspended' | 'purchase.past_due' | 'purchase.cancellation_scheduled' | 'purchase.cancelled' | 'purchase.reactivated' | 'purchase.expired' | 'purchase.renewed' | 'purchase.renewal_reminder' | 'purchase.refunded' | 'purchase.plan_changed' | 'payment.succeeded' | 'payment.failed' | 'payment.refunded' | 'payment.refund_failed' | 'payment.refund_pending' | 'payment.canceled' | 'payment.disputed' | 'payment.dispute_closed' | 'payout.paid' | 'payout.failed' | 'checkout_session.created' | 'checkout_session.completed' | 'checkout_session.expired' | 'customer.credit.topped_up' | 'customer.credit.low_balance' | 'customer.credit.exhausted' | 'customer.credit.debited' | 'customer.credit.granted' | 'customer.credit.adjusted' | 'customer.credit.auto_topup_failed' | 'usage.charged' | 'usage.recorded' | 'usage.reset' | 'product.created' | 'product.updated' | 'product.archived' | 'plan.created' | 'plan.updated' | 'plan.archived' required

Event type.

Example response

{
  "api_version": "2024-01-01",
  "created": 1717000000,
  "id": "evt_1A2B3C4D",
  "livemode": true
}