Get all membership offers

Deprecated

Required Scopes: `MEMBERSHIP_READ` Returns all available membership offers.

Endpoint

GET /v1/memberships/membership-offers

Responses

OK

Response Body application/json

array[object]
id integer(int64) required

Unique identifier for the membership offer.

description required

Description of the membership offer.

Example:  "This offer includes access to all gym facilities and group classes."
name required

Name of the membership offer.

Example:  "Standard Membership"
subDescription

Sub description for the membership offer.

Example:  "Best value for regular gym-goers."
imageUrl

Temporary valid download link for rate bundle image. Expires after 2 hours.

Example:  "https://example.com"
footnote

Contractual or legal comments to be displayed below the offer.

Example:  "This offer is valid for new members only. Terms and conditions apply."
preUseType required

Contract pre-use type information.

Allowed values:
NOT_AVAILABLE Contract is not available for pre-use
CHARGEABLE Contract pre-use is chargeable
FREE Contract pre-use is free
Example:  "NOT_AVAILABLE"
limitedOfferingPeriod required

Represents a date period.

startDate string(date) required

Start of the interval

Example:  "2025-01-01"
endDate string(date) required

End of the interval

Example:  "2026-01-01"
rateCodes array[object] required

Rate codes of the membership offer.

name

The name of the rate code

Example:  "Standard Rate"
identifier

Unique identifier for the rate code.

Example:  "RC12345"
terms array[object] required

List of terms that are part of this membership offer.

id integer(int64) required

Unique identifier of the membership offer term

Example:  1234567890
term

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
contractVolumeInformation

Contains the total amount to be paid during the initial runtime of the contract and the average amounts per month and per the rate's payment frequency (e.g. 1 week)

totalContractVolume

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
averagePaymentVolumePerMonth

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
averagePaymentVolumePerPaymentFrequencyTerm

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
paymentFrequency required

Represents the payment frequency

id integer(int64)

The unique identifier of the payment frequency. (`null` possible for starter package)

Example:  1234567890
type required

Payment frequency type of a contract

Allowed values:
FREE Represents that the contract payment frequency is free of charge.
NON_RECURRING Represents that the contract payment frequency is non recurring, meaning only one payment is necessary here.
RECURRING Represents that the contract payment frequency is recurring, meaning that the payment will take place every term.
MONTH_DAY Represents that the contract payment frequency is based on month days, with a possibly individual price per month day.
TERM_BASED Represents that the contract payment frequency is based on terms, with a possibly individual price per term.
Example:  "FREE"
term

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
price

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
monthDaysToPrices array[object]

Month day to prices list, used for contract payment frequency type `MONTH_DAY`

monthDay required

The month day of the month day to price mapping

month
Allowed values:
JANUARY FEBRUARY MARCH APRIL MAY JUNE JULY AUGUST SEPTEMBER OCTOBER NOVEMBER DECEMBER
monthValue integer(int32)
dayOfMonth integer(int32)
price required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
termsToPrices array[object]

Terms to prices list, used for contract payment frequency type `TERM_BASED`. Note that the price will become active `AFTER` the respective term has passed

term required

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
price required

Represents a financial data

amount required

Amount of the finance data tuple

Example:  20
currency string(ISO 4217) required

Currency of the finance data tuple

Example:  "EUR"
recurring

Whether the cycle of payments repeats indefinitely. Only relevant if type is `TERM_BASED` or `MONTH_DAY`.

ageBasedAdjustments array[object]

List of age-based adjustments for the membership offer module.

ageRange required

Represents an age range.

startAge integer(int32) required

Start age of the range, inclusive.

Example:  18
endAge integer(int32) required

End age of the range, inclusive.

Example:  65
value required

The value of the adjustment, based on `type`.

Example:  10
type required

Age based adjustment type

Allowed values:
ABSOLUTE Absolute adjustment of the price
PERCENTAGE Percentage adjustment of the price
Example:  "ABSOLUTE"
formattedPaymentFrequency required

The formatted payment frequency

Example:  "Every 6 months"
extensionTerm

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"