pass.window_cancelled

A creator cancelled a time-limited pass access window, and its holders were resettled.

Ability to subscribeproject-subscription-plan:view

When this fires

A creator cancelled a scheduled access window from Manage Access Windows or the cancel endpoint: a postponed match, a called-off session. This is never automatic: regeneration, slot edits and plan changes all leave sold windows alone, so cancelling is always a deliberate act.

By the time this fires every holder has already been resettled. Each one was either moved to the next available window on the same plan, or, when nothing suitable was left, had their pass ended and was told to ask the creator for a refund. The tallies are in the payload, and the per-holder detail arrives as pass.holder_moved and pass.holder_stranded for ordinary passes, or pass_series.leg_substituted and pass_series.leg_dropped for season-ticket holders.

Cancelling cannot be undone. The window keeps its start time permanently, so the same instant can never be re-created on that plan: schedule regeneration skips it and adding it by hand is refused.

Caveats

  • Timestamps are UTC; convert to the plan's schedule timezone before showing them.
  • The counts exclude holders who were paused, past due, or had already cancelled their own pass. Those are left bound to the cancelled window and are not resettled or messaged, so reconciling refunds from refund_due alone will miss them. They also exclude season-ticket holders who lost this one date: those are resettled and messaged, and emit pass_series.leg_dropped, but are counted in neither rebound, refund_due, nor subscribers_affected.
  • refund_due is a count, not a list. Consume pass.holder_stranded for the identities and amounts; nothing in the dashboard records them durably.
  • No refund is issued by Subscriby. The buyer is told to contact the creator.
  • Cancelling a window that is already Open evicts its holders immediately: anyone already admitted is removed from the connector's resources and their invite links stop working within seconds. They are not charged again and receive fresh links automatically when their replacement window opens.
  • A cancelled window never emits pass.window_closed.

Related events

  • pass.holder_moved: one per resettled holder.
  • pass.holder_stranded: one per holder owed a refund.

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/pass.window_cancelled

How is this guide?