pass.holder_stranded
A pass holder's window was cancelled with no replacement available, so their pass ended and a refund is owed.
When this fires
One holder of a cancelled access window could not be moved anywhere, so their pass was ended. Fires once per stranded holder of an ordinary pass, alongside the single pass.window_cancelled for the window itself. A season-ticket holder never reaches this state: cancelling one leg of a season emits pass_series.leg_dropped instead and leaves the rest of the slate intact.
They have paid for a date that is not happening and received nothing. Subscriby tells them so and asks them to contact the creator; it does not issue a refund.
This is the durable record of who is owed money. The creator's dashboard shows the refund count once, in a toast that survives a single page load, and the ended subscriptions are afterwards indistinguishable from ordinary expiries. This event carries the identity, the amount and the gateway reference, so consuming it is the only reliable way to reconcile refunds automatically.
Why a replacement can be missing
- The plan has no later window scheduled at all.
- The only later windows are already inside the plan's sales cutoff, so they are closed to sales and cannot take new holders; a later date can be visible on the calendar and still not qualify.
- The customer already holds a pass for every remaining window.
- The plan's repeating schedule has passed its recurrence end date, so no later window qualifies even if the calendar still shows dates.
Caveats
- The subscription also emits
subscription.expired, andmember.churnedwhen it was their last active subscription. De-duplicate if you consume several. - No
subscription.refundedfollows unless the creator actually issues the refund in their payment provider, at which point the gateway's webhook records it. - Holders who were paused, past due, or had already cancelled their own pass are not included, even though they may also have paid. Reconcile those separately.
amount_paidis what the subscription recorded at purchase; it does not account for any partial refund already issued.
Related events
pass.window_cancelled: the window-level event, fired once.pass.holder_moved: the other outcome, when a replacement existed.subscription.expired: also fires for this subscription.
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