Skip to main content
GET
Get the webhook event envelope schema

Authorizations

Authorization
string
header
required

Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.

Response

200 - application/json
api_version
string
required

API version that produced the event payload.

Example:

"2024-01-01"

created
number
required

Unix timestamp (seconds) when the event was created.

Example:

1717000000

data
object
required

Event payload envelope.

id
string
required

Unique event ID.

Example:

"evt_1A2B3C4D"

livemode
boolean
required

True for live-mode events, false for sandbox.

Example:

true

request
object
required

Context about the triggering API request.

type
enum<string>
required

Event type.

Available options:
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
Example:

"purchase.created"