subscription.refunded
Refund recorded against a subscription.
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.refundedonly. 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.
Ability to subscribe
A token needs this to subscribe an endpoint to the event.
Header Parameters
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=.
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.
The event name, the same as the envelope's type.
Always application/json.
Always Subscriby-Webhooks/1.0.
Payload
JSONWhat Subscriby posts to your endpointapplication/json
The signed JSON envelope posted to your endpoint.
The envelope every event is delivered in.
Responses
2XXAny success status
Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.
defaultAny other status
Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from the dashboard or POST /v1/webhook-deliveries/{delivery}/retry. After 20 consecutive failures the endpoint is paused until it is resumed.
How is this guide?
Last updated on