Cancel a pass window
/v1/projects/{project}/pass-windows/{window}/cancel in the Pass Windows API.
curl -X POST https://api.subscriby.net/v1/projects/$PROJECT_ID/pass-windows/$WINDOW_ID/cancel \ -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \ -H "Idempotency-Key: $(uuidgen)"By the time the response arrives every holder has been resettled, and meta says how:
| Tally | What happened to those holders |
|---|---|
rebound | Moved to the plan's next window on sale, and told so. Their invite links are re-issued when the new window opens. |
refund_due | The schedule had nothing left to offer, so their pass was ended and they were told to ask the creator for a refund. |
legs_dropped | Season-ticket holders who lost this one date and keep the rest of their series. Their message states what the date was worth of what they paid. |
Subscriby never moves the refunds.
refund_dueandlegs_droppedare statements, not actions. The money stays where it is until the creator refunds it at the gateway. An integration that wants to act on them should subscribe topass.holder_strandedandpass_series.leg_dropped, which carry the amount per holder.
Cancelling is a POST verb and not a DELETE on purpose: it resettles every holder, moving them on or ending their pass, which is far too consequential to read as removing a row. It also cannot be undone: the window keeps its start permanently, so the same instant can never be re-created on that plan.
Raises pass.window_cancelled carrying the tallies, plus one event per holder: pass.holder_moved or pass.holder_stranded for ordinary passes, pass_series.leg_substituted or pass_series.leg_dropped for season-ticket holders. A window that is already cancelled is answered 200 with every tally at zero, so a retry after a lost response changes nothing.
Requires ability
The token must hold this ability, or the call is refused with 403.
Fires events
Delivered to every endpoint subscribed to them once the change is made.
MCP tool
Runs the same action from an agent, behind the same ability.
Idempotent
Send the header on every call; the same key replays the original response for 24 hours.
Authorization
bearerToken A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.
In: header
Path Parameters
The project, resolved by the route binder.
uuidThe window, resolved within the project.
uuidHeader Parameters
A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.
uuidResponses
200OKapplication/json
The window, cancelled, with meta.rebound, meta.refund_due and meta.legs_dropped.
400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json
Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json
The key was already used in the last 24 hours with a different request body.
425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json
The first request with this key is still running; retry in a few seconds and the original response is replayed.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on