Membership plans
View as MarkdownA membership plan defines the organization, validity period, and fee for memberships in a sport.
On this page
- The membership plan object
- List membership plansGET
/api/v1/membership-plans - Retrieve a membership planGET
/api/v1/membership-plans/{id} - Update a membership planPATCH / PUT / POST
/api/v1/membership-plans/{id} - Delete a membership planDELETE
/api/v1/membership-plans/{id}POST/api/v1/membership-plans/{id}/delete
A membership plan defines the organization, validity period, and fee for memberships in a sport.
Attributes
idinteger- Identifier assigned by the API.
sport_idinteger- Sport associated with this record.
namestring- Name of the plan, up to 100 characters.
organizationstring- Governing organization, up to 100 characters.
card_typestring or null- Membership card category, up to 100 characters.
season_labelstring- Season label, for example 2026/2027. It can be derived from the validity dates.
amountinteger- Non-negative fee in minor currency units.
currencystring- Three-letter currency code. An empty value resets it to EUR.
linked_plan_idinteger or null- ID of a membership-fee plan in the same sport. Requires Plans → Read. Use null to unlink.
excludeinteger- Exclusion flag, represented as 0 or 1.
metadatamap or null- Additional structured data for the plan.
valid_frominteger- Start date as a Unix timestamp in seconds.
valid_tointeger- End date as a Unix timestamp in seconds.
tscinteger- Creation time as a Unix timestamp in seconds.
tsuinteger- Last update time as a Unix timestamp in seconds.
/api/v1/membership-plansLists membership plan records in the workspace.
Permissions
Send your API key in X-API-Key. Required permissions are Membership plans → Read.
Headers
X-Sport-Idinteger- Use the sport ID to limit the response to one sport.
Query parameters
organizationstring- Filter by exact organization name.
seasonstring- Filter by season label, for example 2026/2027.
activeinteger- Use 1 to include only plans whose end date has not passed.
qstring- Search by plan name, organization, card category, or season.
lengthinteger- Number of records to return.
startinteger- Zero-based offset.
drawstring- Optional request marker echoed in the response.
sortstring- Sort by id, name, organization, card_type, season_label, valid_from, valid_to, amount, tsc, or tsu. Prefix the field name with a minus sign for descending order.
orderstring- Direction for unprefixed sort fields. Use asc or desc.
Returns
Returns records in data, the counts before and after text search, and the echoed draw marker.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
/api/v1/membership-plans/{id}Returns one membership plan by ID.
Permissions
Send your API key in X-API-Key. Required permissions are Membership plans → Read.
Headers
X-Sport-IdintegerRequired- The sport ID from List sports. Use the sport the record belongs to.
Path parameters
idintegerRequired- ID of the membership plan.
Returns
The membership plan is returned in data.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.
/api/v1/membership-plans/{id}Updates a membership plan by ID.
Permissions
Send your API key in X-API-Key. Required permissions are Membership plans → Write.
Headers
X-Sport-IdintegerRequired- The sport ID from List sports. Use the sport the record belongs to.
Path parameters
idintegerRequired- ID of the membership plan.
Body parameters
namestring- Name of the plan, up to 100 characters.
organizationstring- Governing organization, up to 100 characters.
card_typestring or null- Membership card category, up to 100 characters.
season_labelstring- Season label, for example 2026/2027. It can be derived from the validity dates.
valid_frominteger or date string- Start date. Provide Unix seconds or an ISO date.
valid_tointeger or date string- End date. It must be on or after the start date. The period may span up to 366 days.
amountinteger- Non-negative fee in minor currency units.
currencystring- Three-letter currency code. An empty value resets it to EUR.
linked_plan_idinteger or null- ID of a membership-fee plan in the same sport. Requires Plans → Read. Use null to unlink.
excludeinteger- Exclusion flag, represented as 0 or 1.
metadatamap or null- Additional structured data for the plan.
Omitted fields retain their values. Each linked membership-fee plan can belong to one active membership plan.
Returns
Returns a successful update response.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.
400- The update failed validation.
/api/v1/membership-plans/{id}/api/v1/membership-plans/{id}/deleteRemoves the plan from the membership plan catalog.
Permissions
Send your API key in X-API-Key. Required permissions are Membership plans → Write.
Headers
X-Sport-IdintegerRequired- The sport ID from List sports. Use the sport the record belongs to.
Path parameters
idintegerRequired- ID of the membership plan.
Returns
Returns a successful removal response.
Errors
401- The API key is missing or invalid.
403- The API key lacks the required permission.
404- The requested record was not found.