Order events
Order events notify your system when meaningful changes occur in the lifecycle of an order. These events are delivered via webhooks and allow you to react to order creation, updates, and successful payment completion in near real time.
Order events are emitted independently of how the order is paid (payment rail, currency, or settlement method).
Supported order events
| Event | Description | When it is emitted |
|---|---|---|
order:created | Emitted when a new order is successfully created. | After the order is initialized and persisted. |
order:updated | Emitted when an existing order is updated. | When mutable fields change (for example status, expiration, metadata, or capabilities). |
order:paid | Emitted when an order becomes fully paid. | When the received payments satisfy the order total. |
Event semantics
order:created
order:createdThis event is emitted once per order.
Typical use cases:
- Persist the order in your internal system
- Initialize fulfillment workflows
- Display payment instructions to the customer
order:updated
order:updatedThis event may be emitted multiple times during the order lifecycle.
Examples of updates that can trigger this event:
- Status transitions (e.g.
awaiting_payment→partially_paid) - Expiration updates
- Metadata changes
- Capability changes (when allowed)
Note
Not every update implies a payment event. For payment-level changes, see Payment events.
order:paid
order:paidThis event is emitted once when the order transitions to the paid status.
Typical use cases:
- Fulfill the order (ship goods, deliver digital content, unlock services)
- Mark the order as completed in your internal system
- Trigger downstream settlement or accounting logic
Important
An order may receive multiple payments before this event is emitted.order:paidis emitted only when the order is fully paid.
Relationship with order lifecycle
Order events are tightly coupled with the order lifecycle:
order:created→initializedorder:updated→ any non-terminal updateorder:paid→ transition topaid
For a detailed view of order status transitions, see Order lifecycle.
Payload overview
All order events include the order object as their main payload. The exact webhook payload format is documented in the Webhooks section.
Updated 7 months ago