Skip to content
GuidesAPI v1admin-sdk 1.1.52Search docs⌘K
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.

EventWhen
orders.pendingThe order was created and is waiting to be paid.
orders.paidThe payment completed. Fulfil the order.
orders.partialPart of the total has been paid.
orders.errorThe payment failed.
orders.confirmedThe merchant accepted the order.
orders.preparedThe order is ready to ship or collect.
orders.shippedThe merchant marked the order shipped.
orders.deliveredThe order was delivered.
orders.completedDelivered and confirmed.
orders.cancelledThe order was cancelled.
orders.returnedThe order came back.
orders.refundedThe payment was refunded.
orders.verifyingThe merchant is checking the order.
orders.staleThe order stayed unpaid for too long.
orders.archivedThe 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.

EventWhen
subscriptions.createdA customer subscribed.
subscriptions.trial_startedA free trial began.
subscriptions.activatedThe subscription is active.
subscriptions.payment_successA renewal was charged.
subscriptions.payment_attempt_failedA renewal attempt failed and will be tried again.
subscriptions.payment_failedA renewal failed. The customer can update their card from a card update link.
subscriptions.trial_endingA trial ends soon.
subscriptions.trial_endedA trial ended.
subscriptions.adhoc_chargeYou charged the subscription outside its cycle.
subscriptions.cancelledThe 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.

EventWhen
subscription.createdA customer subscribed.
subscription.activatedThe subscription became active.
subscription.trial_started / trial_ending / trial_endedA trial began, ends soon, or ended.
subscription.renewedA new period started.
subscription.payment_succeededA renewal was charged.
subscription.payment_attempt_failedA renewal attempt failed and will be tried again.
subscription.payment_failedRenewals gave up.
subscription.grace_started / grace_endedA grace period after a failed renewal began or ended.
subscription.plan_changedThe subscriber moved to another plan.
subscription.paused / resumedBilling was paused or resumed.
subscription.adhoc_chargeYou charged the subscription outside its cycle.
subscription.cancelledThe subscription was cancelled.
card_charge.paid / card_charge.failedA charge of a saved card succeeded or failed.
refund.completedA refund went through.
Was this page helpful?Updated Oct 8, 2026