plans:read. Create, update, retire, and delete operations require plans:write.
Search plans
Requires theplans:read scope.
search(optional) - matches on plan name or descriptionclubId(optional) - only plans limited to that gymsport(optional) - only plans listing that sport, for examplepadelincludeInactive(optional) -trueto include retired plans, which are hidden by defaultlimit(optional) - 1 to 100, defaults to 25offset(optional) - defaults to 0
price is 0 and it cannot be sold through this API.
Get-by-id still resolves one, with seasonId set - check it before treating any
plan as sellable. Add includeInactive=true when you need retired plans as well - to find one
you retired and want back, for example. Name
matching works like
contact search:
case-insensitive and cross-script.
Open a plan
Requires theplans:read scope.
Get-by-id returns retired plans too. Resolving an id you already hold is not the
same as offering a plan for sale, so a plan you retired stays readable here - and
reachable for a
PATCH that un-retires it. Only plan search
hides retired plans, and only until you pass includeInactive=true.Create a plan
Requiresplans:write. Send an Idempotency-Key so a retry cannot create a duplicate.
name and price are required. The other fields are description, clubId, planCategoryId, revenueAccountId, signupFee, billingFrequency (one_time, weekly, monthly, quarterly, annually, or custom), customPeriod, customPeriodUnit (days, weeks, or months), isActive, maxUses, sessionUnit (booking or hour), validityPeriod, autoRenews, renewalDaysInAdvance (0 to 60), requirePaymentUpfront, sports, features, visibility (Private, Member_only, or Public), validFor, and chargesPerSession.
validFor.scopes controls which booking resources the plan can cover. Omit a type list to cover every type in that scope. For example, scopes: ["classes"] covers every class type. Add classTypes: [3, 7] to limit it to those class type IDs.
An empty validFor creates a generic plan for direct gym entry. It does not make class, area, or instructor bookings free.
For a custom billing frequency, send both customPeriod and customPeriodUnit.
chargesPerSession: true makes a per-session plan: price is the fixed part of each month, and each month also charges every session of the class the customer holds a place in. It must be monthly, have no maxUses, cover classes in validFor, and have no season. A membership on it is created with a classId.
Update or retire a plan
Requiresplans:write. Send only fields that should change.
isActive to false to retire a plan. Existing memberships keep their snapshotted plan details, but the plan is no longer something the gym sells.
A retired plan drops out of plan search, so an integration that lists plans stops offering it. It does not disappear:
GET /v1/platform/plans/{id}still returns it, withisActive: false.GET /v1/platform/plans?includeInactive=truelists it again alongside the active ones.PATCHwith{ "isActive": true }puts it back on sale.
Delete a plan
Requiresplans:write.
204 No Content. If memberships or other records still reference the plan, the API returns 409 Conflict. Retire an in-use plan instead of deleting it.
Plan categories
A plan category groups plans under a heading on a price list. Set a plan’splanCategoryId to file it. Categories use the plans scopes and have no paging or search.
GET /v1/platform/plan-categories- every category, in display order, as{ "data": [...] }. Each hascategoryId,name,sortOrder,planCount,createdAt, andupdatedAt. Requiresplans:read.GET /v1/platform/plan-categories/{id}- one category. Requiresplans:read.POST /v1/platform/plan-categories- create one withnameand an optionalsortOrder. Requiresplans:write.PATCH /v1/platform/plan-categories/{id}- rename one or move it in the order. Requiresplans:write.
What the fields mean for a sale
Next step
Pass theplanId to
Create a membership.