subscription.refunded

Refund recorded against a subscription.

Ability to subscribeproject-subscription:view

When this fires

A full subscription-level refund settles. The subscription is always expired as a result: resource access is revoked and subscription.expired (plus member.churned when this was the subscriber's last active subscription) follows for the same subscription.

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.

Caveats

  • Emitted by Stripe, PayPal, Paystack, Razorpay and Skrill. CoinPayments and CeyPay expose no refund notification, so a refund taken there is invisible to this event.
  • A partial refund raises payment.refunded only. This event means the whole charge came back, and access is revoked with it.
  • Skrill reports a chargeback rather than a merchant refund, and only if the creator's Skrill account is configured to post one.
  • Subscriby expires the subscription itself on a full refund; it does not wait for the provider's own cancellation to arrive.
  • For per-payment refunds (no subscription mutation), see payment.refunded.

Related events

  • payment.refunded: payment-level analogue.
  • subscription.cancelled: often paired in practice.

Header Parameters

SB-Signature*string

t=<unix seconds>,v1=<hex>: the HMAC-SHA256 of "<t>.<raw body>" under the endpoint's secret. Verify it before acting, and refuse a t more than 300 seconds from now. During a secret rotation a v0= signature under the previous secret may precede v1=.

SB-Event-Id*string

The event's ULID, bare. The envelope's id is the same ULID prefixed evt_, so strip the prefix before comparing. Deduplicate on it: a retry carries the same id.

SB-Event-Name*string

The event name, the same as the envelope's type.

Content-Type*string

Always application/json.

User-Agent*string

Always Subscriby-Webhooks/1.0.

Request Body

application/json

The signed JSON envelope posted to your endpoint.

TypeScript Definitions

Use the request body type in TypeScript.

The envelope every event is delivered in.

Response Body

Example Requests

POST/subscription.refunded

How is this guide?