Skip to main content
GET
Get a membership scheme
This endpoint is in beta: its request and response contract can still change while it’s being developed.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

schemeId
string
required

The id of one of your membership schemes.

Pattern: ^[a-fA-F0-9]{24}$

Response

The membership scheme.

Public metadata for a membership scheme. Translated text comes with its translations keyed by locale tag, the default under en-GB.

id
string
required
title
string
required
titleByLocale
object
required
productNameType
enum<string>
required

What the scheme sells, for naming it to members.

Available options:
MEMBERSHIP,
TOUR_PASS,
SEASON_PASS
isPurchasable
boolean
required

Whether the scheme is on sale to new members. When false, its offerings list is empty; show disabledContent instead.

summaryMarkdown
string
summaryMarkdownByLocale
object
benefitsMarkdown
string
benefitsMarkdownByLocale
object
disabledContent
MembershipSchemeDisabledContent · object

What a scheme shows while it isn't on sale: a heading, a body and a call to action. Each text comes with its translations keyed by locale tag, the default under en-GB.

heroImageUrl
string
customerSupportEmailAddress
string

Where members contact your organizer about their membership.