Skip to main content
GET
Get a membership plan

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Path Parameters

id
integer
required

Response

The plan

A membership plan. It carries its own price, joining fee, billing frequency and session allowance, so creating a membership only has to name the plan and the customer.

planId
integer
name
string
description
string | null
clubId
integer | null

Club the plan is limited to; null when organization-wide.

seasonId
integer | null

Set when the plan sells a season, and the marker that it is not for sale through this API: a season pass costs the sum of the slots the buyer picks, so the plan's own price is 0 and a membership created against it would put a member on a large contract for nothing. GET /v1/platform/plans excludes these; get-by-id resolves one so a membership already sold against it can be explained. Check it before treating any plan as sellable.

planCategoryId
integer | null

Category the plan is grouped under on price lists; null when ungrouped.

revenueAccountId
integer | null

Ledger account a sale posts to; null means the organization's default account is used at the time of the sale.

price
number

Charged each billing period.

signupFee
number

Charged once when the membership starts, on top of the price.

billingFrequency
string
isActive
boolean

False for a retired plan that is no longer sold.

maxUses
number | null

Session allowance a membership gets; null when unlimited. With several allowances, their total.

sessionUnit
string | null

What a use is counted in - a booking or an hour. Null when the plan has several allowances.

validityPeriod
integer | null

Days the membership stays valid, when time-limited.

autoRenews
boolean

Whether a membership on this plan renews by default.

renewalDaysInAdvance
integer
requirePaymentUpfront
boolean

Whether the club highlights this plan as "Most popular" on its price lists.

isIntroOffer
boolean

Whether the plan is an intro offer for first-time customers, as the First visits report counts it.

customPeriod
integer | null
customPeriodUnit
string | null
minimumTermMonths
integer | null

Months a buyer commits to before the membership may end, counted from its start; null for none.

features
string[]
visibility
enum<string>
Available options:
Private,
Member_only,
Public
validFor
object | null

Booking resource scopes and optional type filters covered by the plan. Null when it has several allowances.

allowances
object[]

The plan's session counters: one for an ordinary plan, several for one like 5 Yoga + 4 Pilates a month. Their coverage never overlaps.

sports
string[]