API reference
Events
An event is a record that something happened. Events are kept 30 days and can be listed whether or not any endpoint is configured, so an integration can catch up after an outage by listing events created[gte] its last processed time. The event list lists every type.
The event object
JSON
{
"id": "evt_srcv6en5gsj0b001t5650atx",
"object": "event",
"livemode": true,
"created": "2026-10-11T14:09:55.764Z",
"type": "order.paid",
"api_version": "2026-10-11",
"data": {
"object": null,
"previous_attributes": {}
},
"request": {
"id": null,
"idempotency_key": null
},
"pending_webhooks": 1
}| Field | Meaning |
|---|---|
pending_webhooks | Deliveries not yet succeeded or given up. |
Every field
Fields of the event object
| Field | Type | Meaning |
|---|---|---|
id | string | Unique identifier: the object prefix, an underscore, 24 lower-case Crockford base32 characters. |
object | string | The type of this object. |
livemode | boolean | true for live mode (real money); false for test mode (simulated payments). |
created | string (date-time) | When the object was created. RFC 3339, UTC, milliseconds. |
type | string | One of ping, checkout_session.created, checkout_, checkout_session.expired, order.created, order.processing, order.paid, order.underpaid, order.overpaid, order.finalized, order.updated, order.screening_hold, order.screening_released, order.expired, order.cancelled, order.refunded, order.partially_refunded, order.overpayment_, payment_, payment_, payment_, payment_, payment_, payment_, payment.seen, payment.confirmed, payment.settled, payment.reverted, payment.unmatched, payment.screening_, order.payment_reverted, order.unpaid, refund.created, refund.signed, refund.sent, refund.confirmed, refund.failed, refund.unknown, refund.cancelled, refund.approval_lapsed, payout.created, payout.signed, payout.sent, payout.confirmed, payout.failed, payout.unknown, payout.cancelled, payout.approval_lapsed, conversion.created, conversion.signed, conversion.sent, conversion.confirmed, conversion.failed, conversion.unknown, conversion.cancelled, conversion.approval_, refund.address_requested, refund.address_lapsed, payout_batch.created, payout_batch.processing, payout_batch.completed, payout_, payout_batch.cancelled, saved_address.created, saved_address.approved, saved_address.active, saved_address.removed, invoice.created, invoice.finalized, invoice.sent, invoice.overdue, invoice.paid, invoice.voided, payment_link.created, payment_link.updated, payment_link.deactivated, product.created, product.updated, price.created, price.updated, customer.created, customer.updated, customer.deleted, subscription.created, subscription.activated, subscription.renewal_due, subscription.renewed, subscription.past_due, subscription.unpaid, subscription.ended, subscription.incomplete_, subscription.payment_, subscription.paused, subscription.resumed, subscription.updated, subscription.cancelled, receipt.created, wallet.deploying, wallet.active, fee_account.low, fee_account.topped_up, export.ready, export.failed, merchant.tier_changed, merchant.limit_, merchant.restricted, merchant.unrestricted, member.invited, member.joined, member.role_changed, member.removed, api_key.created, api_key.rolled, api_key.revoked, webhook_. |
api_version | string | The API version data.object is written in: the endpoint's. |
data | object | The object the event is about, and what changed. |
data.required | object | The full object the event is about, as it was when the event was created, rendered in the endpoint's api_version. |
data. | object | For an event about a change: the old values of the fields that changed. Absent for .created events. |
request | object | The API request that caused the event, or nulls when a payer, the chain, a timer or the dashboard did. |
request. | string or null | The req_ id of that request; null when no API request caused it. |
request. | string or null | The Idempotency-Key it was sent with; null for none. |
pending_webhooks | integer | Deliveries not yet succeeded or given up. |