Get purchasable additional modules

Deprecated

Required Scopes: `MEMBERSHIP_SELF_SERVICE_ADDITIONAL_MODULE_READ` Get purchasable additional modules for a studio and a customer (via main contract)

Endpoint

GET /v1/memberships/{contractId}/self-service/additional-modules/purchasable

Path Parameters

contractId required integer (int64)

Unique ID of the main contract

Responses

OK

Response Body application/json

array[object]
id integer(int64) required

Unique ID of the additional module

Example:  203
name required

Name of the additional module rate

Example:  "drink flat"
description

Description of the additional module rate

Example:  "drink flat"
imageUrl required

Image url of the additional module

Example:  "https://www.image.com"
paymentFrequencies array[object] required

Payment frequencies of the additional module

id integer(int64)

Unique ID of the payment frequency of an additional module

Example:  203
type required

Payment frequency type of an additional module

Allowed values:
FREE Represents that the additional module payment frequency is free of charge.
NON_RECURRING Represents that the additional module payment frequency is non recurring, meaning only one payment is necessary here.
RECURRING Represents that the additional module payment frequency is recurring, meaning that the payment will take place every term.
MONTH_DAY Represents that the additional module payment frequency is based on month days, with a possibly individual price per month day.
TERM_BASED Represents that the additional module 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 additional module 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 additional module 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"
termInformation required

Term information of the additional module

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"
extension

Represents an additional module extension

extensionType required

Extension type of an additional module

Allowed values:
TERM_EXTENSION Represents that the additional module will be extended automatically as soon as cancelation period is over
NEW Represents that a new additional module will be created automatically as soon as cancelation period is over
Example:  "NEW"
termExtension

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"
extensionCancelationPeriod

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"
cancelationPeriod

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"
trialPeriodConfig

Represents the trial period config of an additional module

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"
description

Description of the trial period config

Example:  "Test period for the drink flat"
rateCodes array[object]

Rate codes of the additional module rate

name

The name of the rate code

Example:  "Standard Rate"
identifier

Unique identifier for the rate code.

Example:  "RC12345"
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"