payment.refunded

Dispatch site not yet wired. Subscribe an endpoint now and deliveries will land automatically once the firing site ships.

When this fires

A per-payment refund settles. Pairs with subscription.refunded when the refund covers the entire subscription.

Required ability

project-subscription:view-any — token must carry this at mint time to subscribe an endpoint to this event.

Payload

{
  "id": "evt_01HX...",
  "type": "payment.refunded",
  "created_at": "2026-05-20T10:05:00Z",
  "api_version": "2026-05-01",
  "project_id": "prj_01HX...",
  "data": {
    "subscription_id": "sub_01HX...",
    "plan_id": "pln_01HX...",
    "subscriber_id": "usr_01HX...",
    "external_payment_id": "pi_3Nxy..",
    "amount": "29.00",
    "currency": "USD"
  }
}

Field reference

Field	Type	Notes
`id`	string ULID	Unique event id, prefixed `evt_`. Use for idempotent processing.
`type`	string	Always `payment.refunded` for this event.
`created_at`	ISO 8601 timestamp	Server-side emission time.
`api_version`	string	Webhook API contract version.
`project_id`	string ULID	Project this event belongs to.
`data.subscription_id`	string ULID	Subscription the original payment belonged to.
`data.plan_id`	string ULID	Plan the subscription was on.
`data.subscriber_id`	string ULID	Subscriber's project-scoped user id.
`data.external_payment_id`	string	Provider charge id that was refunded.
`data.amount`	string	Refunded amount in major units of `currency`, formatted as a string.
`data.currency`	string	ISO 4217 currency code.

Caveats

DEFERRED — the dispatch site is not wired yet. Subscriptions taken now stay valid once it ships.
Distinct from subscription.refunded, which represents the subscription's reaction. A refund may emit only payment.refunded if the subscription itself is unaffected.
Partial refunds are represented by amount being less than the original charge.

payment.succeeded — predecessor.
subscription.refunded — subscription-level analogue (also deferred).
Payment events overview — back to family overview.