Webhooks · Event types
Guides / Webhooks
Event types
Order events are named after the order's status; subscription events after what happened to the subscription.
Orders
Subscribe an endpoint to one event, or to orders for both. The body has the order under order, with status as a word.
Order events are named
orders.<status>, but Inkress only sends them when an order is paid and when an unpaid order goes stale. Changing an order's status yourself (for example to shipped) doesn't send a webhook, so don't wait for one.| Event | When |
|---|---|
orders.paid | The payment completed: by card, payment link, checkout session, saved card or subscription. Fulfil the order. |
orders.stale | The order stayed unpaid for too long. |
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