Get a plan

One plan in the same discriminated shape as the list. kind names the one block the plan carries, billing, pass or pass_series; the other two are absent. A plan of another project is 404 RESOURCE_NOT_FOUND, because {plan} is resolved within {project}.

Common fields

Present on every kind.

Field	Type	Notes
`kind`	string	`subscription`, `pass` or `pass_series`. Names the one block below it.
`price`	string	What one purchase costs. On a pass that buys one window; on a series it buys the whole slate, once.
`currency`	object	`{ id, iso, symbol }`.
`cadence`	string	The human-readable duration string: `"Per Month"`, `"Per 3 Hours"`, `"For all 10 passes"`.
`eligibility`	object	Audience restrictions. The first three are mutually exclusive.
`resources`	array	Present when the relation is loaded: each resource's `id`, `name`, `kind` (`manual` or `connector:kind`) and `connector`. On a series these are the lounge, not the thing being sold.

Why cadence exists. Both the portal and the bot already compute exactly this string, and every integrator without it reinvents it, wrongly for a dated plan, printing "1 Month" beside a three-hour window. Use it rather than deriving a duration from the cycle fields.

kind: subscription

Field	Type	Notes
`billing.billing_cycle`	string	`day`, `week`, `month`, `year`, `lifetime`.
`billing.billing_cycle_count`	integer	1–99. Must be `1` when `billing_cycle` is `lifetime`.
`billing.recurring`	boolean	Rejected as `true` for crypto or platform currencies.
`billing.disabled_renewal`	boolean	Charges once, then lapses rather than renewing.
`billing.trial_days`	integer	0–365.
`billing.trial_cardless`	boolean	Whether the trial starts without a payment method.
`billing.trial_type`	string	`project` or `plan`: whose trial rule applies.

kind: pass

A plan that owns its own dated windows and sells one per purchase.

Field	Type	Notes
`pass.timezone`	string	IANA zone the schedule was authored in. Render window times in this, never UTC.
`pass.schedule_mode`	string	`repeating` or `fixed`.
`pass.recurrence`	string \| null	`daily`, `weekly` or `monthly`. Null in `fixed` mode.
`pass.recurrence_ends_at`	timestamp \| null	When window generation stops. Renamed, see the note below.
`pass.sales_cutoff_minutes`	integer \| null	Stops sales this many minutes before the moment `sales_cutoff_anchor` names.
`pass.sales_cutoff_anchor`	string	`before_start` or `before_end`. Never null: a plan that never set it reads as `before_start`. `before_first_end` and `before_last_start` are series-only and refused here.
`pass.slots[].start_time`	string `HH:MM`	Local wall-clock time in `timezone`.
`pass.slots[].duration_minutes`	integer	Each slot carries its own length, so one plan can mix a 3-hour and a 14-hour window.
`pass.upcoming_windows[]`	array	Present only when the relation is loaded. Timestamps are UTC. The pass windows endpoints list and manage a plan's dates.

series_ends_at was renamed to recurrence_ends_at. Same field, same meaning: how long this plan keeps generating windows from its recurrence. It never had anything to do with a Pass Series, but now that a series is a real plan kind, a field called series_ends_at sitting on a pass read as "when this plan's series ends", which is a different thing and one that does not exist here. Update any reader to the new key; there is no alias.

kind: pass_series

A season ticket. It owns no windows: it points at windows that already exist on your pass plans, which is the whole distinction from kind: pass.

Field	Type	Notes
`pass_series.timezone`	string	Borrowed from the source plans; a series has no zone of its own. A series whose sources disagree is refused at authoring time.
`pass_series.prevent_overlaps`	boolean	Refuses to absorb a window clashing with one already on the slate.
`pass_series.sales_cutoff_minutes`	integer	Measured against the whole season, not one window.
`pass_series.sales_cutoff_anchor`	string	Four anchors, earliest deadline first. `before_start` closes before the first window opens. `before_first_end` closes during that opening window. `before_last_start` closes as the last window opens, so a buyer always gets one whole window. `before_end` closes as the last window ends.
`pass_series.seat_cap`	integer \| null	Concurrent holder limit. `null` is unlimited.
`pass_series.seats_taken`	integer	Holders currently counted against the cap.
`pass_series.seats_remaining`	integer \| null	`null` when uncapped.
`pass_series.starts_at`	timestamp \| null	First window's start, UTC.
`pass_series.ends_at`	timestamp \| null	Last window's end, UTC.
`pass_series.window_count`	integer	Slate length. Capped at 120.
`pass_series.successor_plan_id`	string \| null	The next season, offered to holders first when this one finishes.
`pass_series.presale_hours`	integer \| null	How long that offer is held for holders only. 1–8760.
`pass_series.windows[]`	array	The slate. Each entry names the plan the window belongs to; a series can mix several.
`pass_series.windows[].added_by_rule`	boolean	`true` when a rule absorbed it rather than the creator picking it by hand.
`pass_series.rules[]`	array	Automatic inclusion rules. `kind` is `date_range` or `next_n`; `take` is required on `next_n`.
`pass_series.blackout_window_ids`	array	Windows a rule matches but the creator has permanently excluded.

Requires ability

project-subscription-plan:view

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

MCP tool

get_plan

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

plan*string

The plan, resolved within the project by the route binder.

Formatuuid

Responses

200OKapplication/json

The plan.

data*

The response's payload.

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).

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

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.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/plans/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "data": {    "id": "c4e82f16-93a7-4d5b-b81c-6e0f27a94d3b",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "kind": "subscription",    "name": "Premium Monthly",    "description": "Unlimited access to the research channel.",    "price": "29.00",    "currency": {      "id": "8f27a0d4-63be-4915-8c07-1a5d9e34b628",      "iso": "USD",      "symbol": "$"    },    "active": true,    "sales_cap": 10,    "sales_cap_sold": 3,    "position": 0,    "paused": null,    "cadence": "Per Month",    "eligibility": {      "newcomers_only": false,      "customers_only": false,      "churned_only": false,      "single_use": false,      "access_codes_only": false    },    "resources": [      {        "id": "b73c5f21-9d80-4a6e-8215-4f70ce13a9d6",        "name": "Research channel",        "kind": "telegram:supergroup",        "connector": "telegram"      }    ],    "billing": {      "billing_cycle": "month",      "billing_cycle_count": 1,      "recurring": true,      "disabled_renewal": false,      "trial_days": 7,      "trial_cardless": false,      "trial_type": "plan"    },    "created_at": "2026-05-18T10:05:00Z",    "updated_at": "2026-05-18T10:05:00Z"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: PlanResource;}export interface PlanResource {  id: string;  project_id: string;  kind: string;  name: string;  description: string | unknown[] | null;  price: string;  currency: Currency;  active: boolean;  sales_cap: number | null;  sales_cap_sold: number;  position: number | null;  paused: Paused | null;  cadence: string;  eligibility: Eligibility;  resources?: Resource[];  billing?: Billing;  pass?: Pass;  pass_series?: PassSeries | PassSeries2;  created_at: string | null;  updated_at: string | null;}export interface Currency {  id: string;  iso: string;  symbol: string;}export interface Paused {  reason: string;  at: string | null;}export interface Eligibility {  newcomers_only: boolean;  customers_only: boolean;  churned_only: boolean;  single_use: boolean;  access_codes_only: boolean;}export interface Resource {  id: string;  name: string;  kind: string;  connector: string | null;}export interface Billing {  billing_cycle: string | "day" | "week" | "month" | "year" | "lifetime";  billing_cycle_count: number;  recurring: boolean;  disabled_renewal: boolean;  trial_days: number;  trial_cardless: boolean;  trial_type: string | "project" | "plan";}export interface Pass {  timezone: string | null;  schedule_mode: string | null;  recurrence: string | null;  recurrence_ends_at: string | null;  sales_cutoff_minutes: number | null;  sales_cutoff_anchor: string;  slots?: Slot[];  upcoming_windows?: UpcomingWindow[];}export interface Slot {  weekday: number | null;  day_of_month: number | null;  start_time: string;  duration_minutes: number;}export interface UpcomingWindow {  id: string;  starts_at: string;  ends_at: string;  status: string;}export interface PassSeries {  timezone: string;  prevent_overlaps: boolean;  sales_cutoff_minutes: number;  sales_cutoff_anchor: string;  seat_cap: number | null;  seats_taken: number;  seats_remaining: number | null;  starts_at: string | null;  ends_at: string | null;  window_count: number;  successor_plan_id: string | null;  presale_hours: number | null;  windows: Window[];  rules: Rule[];  blackout_window_ids: Record<string, unknown>;}export interface Window {  id: string;  plan_id: string;  plan_name: string;  starts_at: string;  ends_at: string;  status: string;  added_by_rule: boolean;}export interface Rule {  source_plan_id: string;  kind: string;  from_at: string | null;  to_at: string | null;  take: number | null;}export interface PassSeries2 {  timezone: unknown | null;  prevent_overlaps: boolean;  sales_cutoff_minutes: number;  sales_cutoff_anchor: string;  seat_cap: unknown | null;  seats_taken: number;  seats_remaining: unknown | null;  starts_at: unknown | null;  ends_at: unknown | null;  window_count: number;  successor_plan_id: unknown | null;  presale_hours: unknown | null;  windows: string[];  rules: string[];  blackout_window_ids: string[];}

Get a plan

Common fields

kind: subscription

kind: pass

kind: pass_series

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Authorization

Path Parameters

Responses