Early bird discounts live! Claim your offer

payment.refunded

A specific charge is refunded, fully or partially.

Fires only for a settled refund. A refund a provider has queued but not yet paid out raises nothing — access is never revoked for money that has not actually moved.

When this fires

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

Required ability

project-subscription:view — 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": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
  "data": {
    "subscription_id": "5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4",
    "plan_id": "c4e82f16-93a7-4d5b-b81c-6e0f27a94d3b",
    "subscriber_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",
    "external_payment_id": "pi_3Nxy..",
    "amount": "29.00",
    "full_refund": true
  }
}

Field reference

FieldTypeNotes
idstring ULIDUnique event id, prefixed evt_. Use for idempotent processing.
typestringAlways payment.refunded for this event.
created_atISO 8601 timestampServer-side emission time.
api_versionstringWebhook API contract version.
project_idstring UUIDProject this event belongs to.
data.subscription_idstring UUIDSubscription the original payment belonged to.
data.plan_idstring UUIDPlan the subscription was on.
data.subscriber_idstring UUIDSubscriber's project-scoped user id.
data.external_payment_idstring | nullProvider charge id that was refunded. null when the provider's refund payload carried no originating charge id (Razorpay).
data.amountstringRefunded amount in major units of the subscription's currency, as a decimal string. The currency itself is not carried on this event — resolve it from the plan or from the preceding payment.succeeded.
data.full_refundbooleantrue when the refund unwinds the whole charge. A full refund additionally emits subscription.refunded and immediately revokes access; a partial one does not.
data.reasonstring | undefinedProvider-supplied refund reason, or chargeback for reversals. Omitted entirely when the provider supplied none — never sent as null.

Caveats

  • Emitted by Stripe, PayPal, Paystack, Razorpay and Skrill. CoinPayments and CeyPay expose no refund notification.
  • Raised for partial refunds as well as full ones. Read full_refund to tell them apart — a partial refund leaves the subscription and its access untouched.
  • Stripe reports a running total across refunds; the amount here is this refund, not the cumulative figure.
  • 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.

How is this guide?

On this page

Subscriby is a product designed by you — for you.

No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request