Version
DESTRUCTIVE

cancel_pass_window

Cancel one dated access window and resettle everyone holding it. Destructive — holders are messaged and money may be owed.

Take a window off the schedule and deal with the people who bought it, the way the dashboard's cancel dialog does. Each holder is resettled in one of three ways:

  • rebound — moved to the plan's next window that is on sale;
  • leg dropped — for a season-ticket holder, the one date is removed from their series and the rest stands;
  • refund due — when the schedule has nothing left to move them to, their pass is ended and flagged for a refund.

A single-date holder is always moved where a window is on sale. A season-ticket holder follows series_holders: substitute (the default) moves them too, keeping their season at the same length; drop removes the cancelled date from their season instead. A weekly season always has a next date on sale, so a day with no event is the case for drop; confirm the choice with the creator, since it decides who is owed money.

Subscriby never moves the money itself. meta.refunds lists every holder the creator now owes a decision, with what they paid and what the cancelled date was worth in the words the holder was told, and meta.refund_totals adds them up per currency; the creator settles them with their payment provider, and sees the same list in the dashboard and in a notice.

Destructive — confirm the window with a human first

Holders are messaged the moment this runs and refunds may be owed. Read the window back with get_pass_window, check its holders, and have the creator confirm the exact window_id before calling.

Emits pass.window_cancelled once, plus one of pass.holder_moved, pass.holder_stranded or pass_series.leg_dropped per holder. Idempotent: an already-cancelled window is answered with zero tallies and emits nothing.

Requires ability

The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.

The REST endpoint and this tool share one action, so validation, permissions and events are identical.

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

Annotations

DestructiveIdempotent

A client that honours annotations asks a person before running it. Sending the same arguments twice changes nothing the second time.

Arguments

project_id*string

UUID of the project whose pass plans own the window.

window_id*string

UUID of the window to cancel.

series_holdersstringoptional

What happens to season-ticket holders of the window: "substitute" (the default) moves them to the plan's next window on sale, keeping their season at the same length; "drop" removes the cancelled date from their season, leaves the rest standing and reports what the date was worth per holder. Single-date holders are always moved where a window is on sale.

substitutedrop

What it returns

{  "data": {    "id": "3d5a8c72-b016-4e94-8fa7-61c209d4e738",    "plan_id": "9b7c2e15-4d63-4f80-a2b1-7e5d0c9f3a46",    "plan_name": "Saturday session",    "starts_at": "2026-10-03T09:00:00+00:00",    "ends_at": "2026-10-03T11:00:00+00:00",    "timezone": "Europe/London",    "local_range": "Sat 3 Oct, 10:00–12:00 BST",    "duration_minutes": 120,    "status": "canceled",    "sellable": false,    "holders": 3  },  "meta": {    "rebound": 2,    "refund_due": 1,    "legs_dropped": 0,    "subscribers_affected": 3,    "series_holders": "substitute",    "refunds": [      {        "subscription_id": "5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4",        "subscriber_id": "2a91c4e7-6f38-4b52-8e0d-9c1a7b3f5d80",        "member": "Jane Fox",        "reason": "stranded",        "amount": "15.00",        "amount_formatted": "£15.00",        "amount_paid": "15.00",        "amount_paid_formatted": "£15.00",        "currency": "GBP",        "passes_remaining": 0      }    ],    "refund_totals": [      {        "currency": "GBP",        "amount": "15.00",        "formatted": "£15.00"      }    ]  }}

holders is the count at the moment of cancellation, so the three tallies under meta add up to it. status is spelled canceled.

How it fails

VALIDATION_FAILED

the window cannot be cancelled in its current state (the resettlement refused).

RESOURCE_NOT_FOUND

unknown project_id or window_id, a window of another project, or a project outside the token's scope.

AUTHENTICATION_REQUIRED

no authenticated user on the request.

TOKEN_MISSING_ABILITY

token lacks pass-window:delete.

How is this guide?

Last updated on