Version

Pass Windows API

A pass window is one dated stretch of access on a kind: pass plan: the Saturday 09:00–12:00 a buyer of a match-day pass actually gets.

A pass window is one dated stretch of access on a kind: pass plan: the Saturday 09:00–12:00 a buyer of a match-day pass actually gets. Most windows are generated from the plan's slots; a creator can also place one by hand. A pass series is a slate of these windows, so their ids are what a series points at.

Windows are their own resource rather than an include on the plan: an integration authoring a series needs the ids without pulling a whole plan per source plan. The writes are the three the dashboard's Manage Access Windows panel offers (place a date, cancel one, nudge its holders) and they run the same actions the panel does.

Endpoints

curl "https://api.subscriby.net/v1/projects/$PROJECT_ID/pass-windows?status=scheduled&sellable_only=true" \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

The project's windows across every pass plan, soonest first, 50 per page (per_page 1 to 100; limit is accepted as an alias). Filters are validated before they reach the query: an unknown status or a malformed date is a 422 VALIDATION_FAILED naming the field, not an empty page.

The list also opens to project-subscription-plan:view-any. The list shipped under the plan ability before the pass-window:* family had any surface, and it is what the n8n node and the MCP tool docs named. A token holding only project-subscription-plan:view-any therefore still satisfies the pass-window:view-any gate. Mint new tokens with the precise ability; the alias exists so old ones keep working.

GET
/v1/projects/{project}/pass-windows

Requires ability

The token must hold this ability, or the call is refused with 403.

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken
AuthorizationBearer <token>

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

project*string

The project, resolved by the route binder.

Formatuuid

Query Parameters

plan_id?|

One pass plan of the project only.

Formatuuid
status?|

One state only: scheduled, open, closed or canceled. Anything else is refused.

from?|

Only windows starting at or after this moment, ISO 8601.

Formatdate-time
to?|

Only windows starting at or before this moment, ISO 8601.

Formatdate-time
sellable_only?boolean

Keep only windows a buyer could still purchase.

page?integer

The 1-based page to return. A page past the last answers an empty data array with meta.total still filled, so a loop can stop without guessing.

Range1 <= value
Default1
per_page?integer

Rows per page, 1 to 100. A higher value clamps to the cap silently. Defaults to 50.

Range1 <= value <= 100
Default50
sort_by?string

The column to order by. Defaults to created_at; a column the endpoint does not offer falls back to the default rather than failing.

Default"created_at"
sort_direction?string

asc or desc. Defaults to desc.

Default"desc"

Value in

  • "asc"
  • "desc"
limit?integer

Legacy alias of per_page, kept for clients that predate it. per_page wins when both are sent.

Range1 <= value <= 100

Responses

200OK

The page, soonest first.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403Forbidden

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 found

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.

422Validation failed

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when status is not one of the four states, plan_id is not a UUID, or from or to is not a date.

429Too many requests

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

Get a pass window

GET

One window, with sellable and holders resolved for it. A window is resolved within the project: a window id that belongs to another project, another team, or to nothing at all is a 404 RESOURCE_NOT_FOUND, so an id's existence never leaks.

FieldTypeNotes
starts_atstringISO 8601, UTC. Store this.
ends_atstringISO 8601, UTC.
timezonestringThe IANA zone the plan's schedule was authored in. Render window times in this, never in UTC.
local_rangestringThe same window as a person reads it, already in timezone: what the dashboard, the portal and the bot all print.
duration_minutesintegerDerived from the two instants.
statusstringscheduled, open, closed or canceled. Set by the scheduler as the window's start and end pass; canceled only by an explicit cancel.
sourcestringgenerated from the plan's slots, or manual when placed by hand. Manual windows survive a schedule rebuild; generated ones are regenerated.
sellablebooleanWhether a buyer could purchase this window right now: the plan's sales cutoff, resolved for the whole page in one query rather than per row.
holdersintegerHow many purchases currently hold the window.

Why both UTC and a local range. A pass schedule is authored in the creator's zone and rendered in it everywhere else in the product. Returning only UTC would leave every consumer converting, and getting it wrong across a daylight-saving boundary. starts_at is for storing and comparing; local_range is for showing.

GET
/v1/projects/{project}/pass-windows/{window}

Requires ability

The token must hold this ability, or the call is refused with 403.

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken
AuthorizationBearer <token>

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

project*string

The project, resolved by the route binder.

Formatuuid
window*string

The window, resolved within the project with its holder count and sale flag.

Formatuuid

Responses

200OK

The window.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403Forbidden

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 found

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.

429Too many requests

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

POST

Places a window by hand on a kind: pass plan. This is how schedule_mode: fixed gets its dates, and how a repeating plan gets the one-off that does not fit its pattern.

curl -X POST https://api.subscriby.net/v1/projects/$PROJECT_ID/plans/$PLAN_ID/pass-windows \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{    "starts_at": "2026-09-20 09:00",    "duration_minutes": 180  }'

Answers 201 with the new window: status: scheduled, source: manual, holders: 0. The request above and "starts_at": "2026-09-20T09:00:00-04:00" describe the same instant for a plan in America/New_York, and both come back as "2026-09-20T13:00:00+00:00". Raises pass.window_scheduled with source: manual.

A manual window is never touched by regeneration: editing pass.slots on the plan rebuilds the generated windows and leaves this one where you put it. Every pass series with a rule is asked to look at the new date afterwards, so a matching series absorbs it as described on the Plans page.

Each refusal below is a 422 VALIDATION_FAILED naming the field, the same wording the dashboard's panel shows.

POST
/v1/projects/{project}/plans/{plan}/pass-windows

Requires ability

The token must hold this ability, or the call is refused with 403.

Fires one event

Delivered to every endpoint subscribed to it once the change is made.

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
AuthorizationBearer <token>

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

project*string

The project, resolved by the route binder.

Formatuuid
plan*string

The plan, resolved within the project.

Formatuuid

Header Parameters

Idempotency-Key*string

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.

Formatuuid

Request body

JSONWhat the request carries

A window to place by hand on a time-limited pass plan: when it starts and how long it lasts.

Responses

201Created

The window.

400Bad request

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403Forbidden

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 found

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.

409Conflict

The key was already used in the last 24 hours with a different request body.

422Validation failed

The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with error.message saying why and no fields. On this endpoint: VALIDATION_FAILED: when the plan is not a time-limited pass: a subscription or a series has no windows of its own. VALIDATION_FAILED: when the start is in the past, judged in the plan's own zone. VALIDATION_FAILED: when the length is under the plan's floor or over its ceiling (5 minutes and 30 days by default). VALIDATION_FAILED: when the plan already has a window starting at that instant. VALIDATION_FAILED: when the plan stops selling a fixed number of minutes before a window **ends** and the window is not longer than that cutoff, so it would never be on sale while it runs.

425Too early

The first request with this key is still running; retry in a few seconds and the original response is replayed.

429Too many requests

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

Cancel a pass window

POST
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:

TallyWhat happened to those holders
reboundMoved to the plan's next window on sale, and told so. Their invite links are re-issued when the new window opens.
refund_dueThe schedule had nothing left to offer, so their pass was ended and they were told to ask the creator for a refund.
legs_droppedSeason-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_due and legs_dropped are 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 to pass.holder_stranded and pass_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.

POST
/v1/projects/{project}/pass-windows/{window}/cancel

Requires ability

The token must hold this ability, or the call is refused with 403.

Delivered to every endpoint subscribed to them once the change is made.

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
AuthorizationBearer <token>

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

project*string

The project, resolved by the route binder.

Formatuuid
window*string

The window, resolved within the project.

Formatuuid

Header Parameters

Idempotency-Key*string

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.

Formatuuid

Responses

200OK

The window, cancelled, with meta.rebound, meta.refund_due and meta.legs_dropped.

400Bad request

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403Forbidden

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 found

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.

409Conflict

The key was already used in the last 24 hours with a different request body.

425Too early

The first request with this key is still running; retry in a few seconds and the original response is replayed.

429Too many requests

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

POST

Nudges everyone who bought the window but has not yet joined, re-attaching their invite links. It is the panel's Send Reminder button; the automatic reminders a day and an hour before a window opens still run regardless.

curl -X POST https://api.subscriby.net/v1/projects/$PROJECT_ID/pass-windows/$WINDOW_ID/remind \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \  -H "Idempotency-Key: $(uuidgen)"

reminded is how many holders the connector accepted a message for, not how many were attempted: a holder who has blocked the bot is skipped without costing the rest their nudge. A window that has ended or been cancelled reminds nobody and answers 0 rather than refusing. No event fires: the reminder is a message on the connector, not a state change.

This messages real people. Do not repeat it within the same window, and to nudge one holder rather than a whole window use the subscription remind endpoint.

POST
/v1/projects/{project}/pass-windows/{window}/remind

Requires ability

The token must hold this ability, or the call is refused with 403.

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
AuthorizationBearer <token>

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

project*string

The project, resolved by the route binder.

Formatuuid
window*string

The window, resolved within the project.

Formatuuid

Header Parameters

Idempotency-Key*string

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.

Formatuuid

Responses

200OK

window_id and how many holders were reminded.

400Bad request

Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.

401Unauthorized

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

403Forbidden

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 found

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.

409Conflict

The key was already used in the last 24 hours with a different request body.

425Too early

The first request with this key is still running; retry in a few seconds and the original response is replayed.

429Too many requests

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?

Version

On this page

Subscriby is a product
designed by you — for you.
No boardroom full of executives deciding what we ships next. Our roadmap always shaped by you with your feedback.

Share feedback or a request