Webhooks · Event types
Guides / Webhooks
Event types
Order events are named after the order's new status; subscription events after what happened to the subscription.
Orders
Subscribe an endpoint to one event, or to orders for all of them. The body has the order under order, with status as a word.
| Event | When |
|---|---|
orders.pending | The order was created and is waiting to be paid. |
orders.paid | The payment completed. Fulfil the order. |
orders.partial | Part of the total has been paid. |
orders.error | The payment failed. |
orders.confirmed | The merchant accepted the order. |
orders.prepared | The order is ready to ship or collect. |
orders.shipped | The merchant marked the order shipped. |
orders.delivered | The order was delivered. |
orders.completed | Delivered and confirmed. |
orders.cancelled | The order was cancelled. |
orders.returned | The order came back. |
orders.refunded | The payment was refunded. |
orders.verifying | The merchant is checking the order. |
orders.stale | The order stayed unpaid for too long. |
orders.archived | The order was archived. |
Subscriptions
Subscribe to one event or to subscriptions. The body has subscription, plan and customer, and order when a payment was involved.
| Event | When |
|---|---|
subscriptions.created | A customer subscribed. |
subscriptions.trial_started | A free trial began. |
subscriptions.activated | The subscription is active. |
subscriptions.payment_success | A renewal was charged. |
subscriptions.payment_attempt_failed | A renewal attempt failed and will be tried again. |
subscriptions.payment_failed | A renewal failed. The customer can update their card from a card update link. |
subscriptions.trial_ending | A trial ends soon. |
subscriptions.trial_ended | A trial ended. |
subscriptions.adhoc_charge | You charged the subscription outside its cycle. |
subscriptions.cancelled | The subscription was cancelled. |
Order bodies also carry flat fields from the earlier format (
reference, amount, currency, status, card_suffix) and a jwt of the same event. New code should read order.Subscription, card charge and refund events
A second family of events has one envelope for all of them: id, type, version, created_at, timestamp, merchant, reference_id and data, signed the same way. X-Inkress-Webhook-ID is the event's id. Subscribe an endpoint to an event by name or to its family: subscription, card_charge or refund. These events never go to all, orders or subscriptions endpoints.
| Event | When |
|---|---|
subscription.created | A customer subscribed. |
subscription.activated | The subscription became active. |
subscription.trial_started / trial_ending / trial_ended | A trial began, ends soon, or ended. |
subscription.renewed | A new period started. |
subscription.payment_succeeded | A renewal was charged. |
subscription.payment_attempt_failed | A renewal attempt failed and will be tried again. |
subscription.payment_failed | Renewals gave up. |
subscription.grace_started / grace_ended | A grace period after a failed renewal began or ended. |
subscription.plan_changed | The subscriber moved to another plan. |
subscription.paused / resumed | Billing was paused or resumed. |
subscription.adhoc_charge | You charged the subscription outside its cycle. |
subscription.cancelled | The subscription was cancelled. |
card_charge.paid / card_charge.failed | A charge of a saved card succeeded or failed. |
refund.completed | A refund went through. |
Was this page helpful?Updated Oct 8, 2026