Preview information before signing up for a new membership

Deprecated

Required Scopes: `MEMBERSHIP_READ`

Endpoint

POST /v1/memberships/signup/preview

Request Body application/json

required

The information used for the membership signup

contract required

The contract information used for the membership signup

contractOfferTermId integer(int64) required

Unique ID of the contract offer term

Example:  1000
startDate string(date) required

The start date of the contract

Example:  "2026-02-01"
preuseDate string(date)

The pre use date of the contract. If not provided, it will be evaluated based on contract offer configuration.

Example:  "2026-01-01"
notes

The notes related to the contract

Example:  "Some notes"
thirdPartyId

Unique ID of the third party contract in the third party system

Example:  "1000a"
employeeId integer(int64)

Unique ID of the employee who created the membership

Example:  1239812733
referralCode

Referral code to link with recruiter

Example:  "A500D"
selectedSelectableModuleIds array[integer(int64)]

The selected modules from the available selectable modules

selectedOptionalModuleIds array[integer(int64)]

The selected modules from the available optional modules

initialPaymentRequestToken

This token identifies a pre-authorized payment request. It acts as a reference to the payment session initiated by the user. It's not needed for preview endpoints.

Example:  "3JtyH5sakfn2V22vB0napNC2zWMlpFwS9gPQawuk7Jw1F00atOD0BA"
contractSignature

Representing customer signature

base64SvgSignature required

Customer confirmation signature SVG value as base 64 string

textBlockSignatures array[object]

Signatures for text blocks

base64SvgSignature required

Text block's signature SVG value as base 64 string

textBlockId integer(int64) required

The ID of the referenced text block of the signature

voucherCode

An optional code for a voucher. Only credit and discount vouchers are supported.

Example:  123
customer required

The customer information used for the membership signup

thirdPartyId

Unique ID of the third party customer in the third party system

Example:  "A1000"
firstName required

First name of the customer

Example:  "Peter"
secondFirstName

Second first name of the customer

Example:  "Thomas"
lastName required

Last name of the customer

Example:  "Muller"
secondLastName

Second last name of the customer

Example:  "Meyer"
dateOfBirth string(date) required

Date of birth of the customer

Example:  "2019-08-24"
placeOfBirth

Place of birth of the customer. Required for Italian studios and nationals.

countryOfBirth

Country of birth of the customer. Required for Italian studios and non-Italian nationals

email required

Email address of the customer

Example:  "example@example.com"
gender

Gender of the customer

Allowed values:
MALE Male gender of the customer
FEMALE Female gender of the customer
UNISEX Unisex gender of the customer
Example:  "MALE"
phoneNumberPrivate

Private phone number of the customer

Example:  "+44123456789"
phoneNumberMobile

Mobile phone number of the customer

Example:  "+44987654321"
street required

Street of the customer's address

Example:  "Raboisen Street"
secondStreet

Second street line of the customer's address

Example:  "Second Street"
cityPart

City part of the customer's address

Example:  "Tegel"
district

District of the customer's address

Example:  "District 12"
streetType

Street type of the customer's address

Example:  "Avenue"
streetBlock

Street block of the customer's address

Example:  "5th block"
portal

Portal of the customer's address

Example:  "Portal 1"
stairway

Stairway of the customer's address

Example:  "Right stairway"
door

Door of the customer's address

Example:  "Door 1"
province

Province of the customer's address

Example:  "Champagne"
additionalAddressInformation

Additional address information of the customer's address

Example:  "Additional information"
floor

Floor of the customer's address

Example:  "2nd floor"
language required

Basic language information

languageCode string(ISO 639-1) required

The language code

Example:  "de"
countryCode string(ISO 3166-1)

The country code

Example:  "DE"
houseNumber

House number of the customer's address

Example:  "3-4"
buildingName

Building name

Example:  "Empire State Building"
city required

City of the customer's address

Example:  "Hamburg"
zipCode required

Zip code of the customer's address

Example:  "220-99"
countryCode string(ISO 3166-1) required

Country code of the customer's address

Example:  "DE"
taxId

Required if the studio is located in Spain or Italy. Alternatively, a valid document identification can be provided.

Example:  "12345678A"
communicationPreferences array[object]

List of communication preferences for the customer

messageCategory

The message category of the communication preference

Allowed values:
CONTRACT The message category is contract related
GENERAL The message category is general
APPOINTMENT The message category is appointment related
NEWSLETTER The message category is newsletter related
LOYALTY_PROGRAM The message category is loyalty program related
Example:  "CONTRACT"
channels array[object]

The communication channels related to the message category of the communication preference

communicationChannel required

The communication channel

Allowed values:
LETTER Communication via letter
EMAIL Communication via email
TEXT_MESSAGE Communication via text message
PHONE Communication via phone
FAX Communication via fax
CONVERSATION Communication via conversation
CHAT Communication via chat
OTHER Communication via other means
Example:  "EMAIL"
customerOverridable

Indicates if the customer can override the communication channel

Example:  true
active

Indicates if the communication channel is active

Example:  true
documentIdentification

Information from an official document that identifies the customer

documentNumber required

Document number

Example:  "CX5432112345DS"
documentType required

Type of the document

Allowed values:
ID_CARD National identification card
PASSPORT International passport
DRIVERS_LICENCE Driver's license
RESIDENCE_PERMIT Residence or visa permit
NATIONAL_ID_NUMBER National identification number
OTHERS Other types of identification documents
Example:  "ID_CARD"
paymentRequestToken

By assigning the `paymentRequestToken` to the customer, the payment method associated with the token will be used as payment method setting of the customer. Additionally, if the `paymentRequestToken` is associated with a payment instrument, i.e. a SEPA Mandate, BACS Mandate, Credit Card, or other, the payment instrument will be made available in the member account for future collection via payment runs. By leaving this field empty the payment method of the customer will be set to `CASH`. For reference check 'Create a user payment session'.

additionalInformationFieldAssignments array[object]

List of additional information field assignments of the customer

additionalInformationFieldId integer(int64) required

The unique ID of the additional information field

Example:  1234567890
value required

The value of the additional information field assignment. For list fields this is the id of the selected item, for text fields this is the text value, for numeric fields must be positive or negative integers, for date fields this is the date in ISO-8601 format, and for boolean fields this is 'true' or 'false'.

Responses

OK

Response Body application/json

basePrice 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"
preUseCharge

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

Type of a voucher, if a valid voucher code has been provided

Allowed values:
CONTRACT Represents a contract voucher
CREDIT Represents a credit voucher
DISCOUNT Represents a discount voucher
COMPANY_FEE_SPLIT Represents a company fee split voucher
CHECKIN Represents a check-in voucher
Example:  "DISCOUNT"
voucherRemarks

Voucher remarks, if a valid voucher code has been provided

Example:  "Yoga class not included"
voucherEffectivePeriod deprecated

The type of period for which the voucher is applied, if a valid voucher code has been provided. Deprecated: Use voucherDiscountPeriods[].effectivePeriod instead to see periods per discount period.

Allowed values:
UNLIMITED Represents a voucher with unlimited effective period
INITIAL_TERM Represents a voucher effective during the initial term of the membership
TIME_BASED Represents a voucher with a time based effective period
Example:  "UNLIMITED"
effectivePeriodTimeBasedTerm

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

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"
discountType deprecated

Type of discount (percentage or absolute), if a valid discount voucher code has been provided. Deprecated: Use voucherDiscountPeriods[].discountType instead to see discount types per discount period.

Allowed values:
ABSOLUTE Represents an absolute discount
PERCENTAGE Represents a percentage based discount
Example:  "PERCENTAGE"
discountValue

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"
voucherDiscountPeriods array[object]

List of discount periods for the voucher, if a valid discount voucher code has been provided. Each period has its own discount and effective period.

discountType required

Type of discount (percentage or absolute)

Allowed values:
ABSOLUTE Represents an absolute discount
PERCENTAGE Represents a percentage based discount
Example:  "PERCENTAGE"
discountValue 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"
effectivePeriod required

The type of period for which this discount is applied

Allowed values:
UNLIMITED Represents a voucher with unlimited effective period
INITIAL_TERM Represents a voucher effective during the initial term of the membership
TIME_BASED Represents a voucher with a time based effective period
Example:  "TIME_BASED"
effectivePeriodTimeBasedTerm

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

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

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

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

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

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

Type of company fee split (percentage or absolute), if a valid company discount voucher code has been provided

Allowed values:
ABSOLUTE Represents an absolute discount
PERCENTAGE Represents a percentage based discount
Example:  "ABSOLUTE"
companyFeeSplitValue

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

Name of the company that will pay the company amount, if a valid company discount voucher code has been provided

Example:  "Some company"
companyAmountPreUseCharge

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

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

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

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

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

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

Represents a membership offer rate bonus period.

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"
termStrategy required

Membership offer rate bonus period term strategy.

Allowed values:
CONTRACT_START Contract start date
FIXED Fixed date
END_OF_CURRENT_TERM End of current term
START_OF_NEXT_TERM Start of next term
Example:  "CONTRACT_START"
displaySeparately

Indicates whether the bonus period should be displayed separately in the offer details

Example:  true
runtimeExtensionType required

Membership offer bonus period type.

Allowed values:
WITH_EXTENSION Period with extension
WITHOUT_EXTENSION Period without extension
Example:  "WITH_EXTENSION"
extendsCancellationPeriod

Indicates whether the bonus period extends the cancellation period

Example:  false
voucherTextBlocks array[object]

Voucher related text blocks, if a valid voucher code has been provided

id integer(int64)

The unique identifier of the text block

Example:  1234567890
title

The title of the text block

Example:  "Title of 1. text block"
text

The text of the text block

Example:  "Text of 1. text block"
order integer(int32)

The order of the text block in the contract

Example:  1
hasSignature

Text block configuration has a signature field. You have the option to show a signature input field and it will be added in the contract document. It is not a required field in magicline. It is up to your implementation if you add this field.

showCommunicationPrivacyOptions

Text block contains information about the communication privacy options. You are advised to show a matrix with communication settings in combination with this text block.

attachmentType

Indicates the type of attachment for this block

Allowed values:
NONE No text block
FILE File information available in `attachedDocument`
URL Url information available in `attachedExternalUrlDto`
CONTRACT_PDF_PREVIEW Contract PDF preview
Example:  "CONTRACT_PDF_PREVIEW"
attachedExternalUrlDto

Represents url information.

title required

Url title

Example:  "Example Resource"
url required

Url to access the resource

Example:  "https://some-url.com"
attachedDocument

Represents document information.

fileName required

Name of the file to download

Example:  "contract.pdf"
url required

Temporary valid download link. Expires after 5 hours.

Example:  "https://some-url.com"
rateBundleModuleId integer(int64)

The ID of the associated rate bundle module. Only set if this is a module consent text block.

Example:  1234567890
confirmationRequired
flatFeePreviews array[object]

Flat fee previews, including discount if a valid discount voucher code has been provided

name required

Name of the sub contract

Example:  "Sauna"
discountedPrice

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"
discountPeriods array[object]

List of discount periods for the sub contract, if a valid discount voucher code has been provided

discountType required

Type of discount (percentage or absolute)

Allowed values:
ABSOLUTE Represents an absolute discount
PERCENTAGE Represents a percentage based discount
Example:  "PERCENTAGE"
discountValue 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"
effectivePeriod required

The type of period for which this discount is applied

Allowed values:
UNLIMITED Represents a voucher with unlimited effective period
INITIAL_TERM Represents a voucher effective during the initial term of the membership
TIME_BASED Represents a voucher with a time based effective period
Example:  "TIME_BASED"
effectivePeriodTimeBasedTerm

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

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

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

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

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

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

The method that is being used to determine the period for the first payment

Allowed values:
REFERENCE_DATE NORMALIZATION_ON_CALENDAR_UNIT
Example:  "REFERENCE_DATE"
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"
voucherBonusPeriod

Represents a membership offer rate bonus period.

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"
termStrategy required

Membership offer rate bonus period term strategy.

Allowed values:
CONTRACT_START Contract start date
FIXED Fixed date
END_OF_CURRENT_TERM End of current term
START_OF_NEXT_TERM Start of next term
Example:  "CONTRACT_START"
displaySeparately

Indicates whether the bonus period should be displayed separately in the offer details

Example:  true
runtimeExtensionType required

Membership offer bonus period type.

Allowed values:
WITH_EXTENSION Period with extension
WITHOUT_EXTENSION Period without extension
Example:  "WITH_EXTENSION"
extendsCancellationPeriod

Indicates whether the bonus period extends the cancellation period

Example:  false
creditValue

Voucher credit value, if a valid credit voucher code has been provided

Example:  20
identifier required

Unique identifier of the flat fee

Example:  "FLATFEE0-0F7691D0E09A4477A5CC69C8BD3F223B"
voucherSuccessMessage

Textual representation of the voucher conditions, if a valid voucher code has been provided

Example:  "Voucher code \"123\" successfully applied: 5% discount on the membership fee"
voucherErrorCode

An error code, if the voucher code is invalid

Allowed values:
INVALID_CODE Represents an invalid voucher code
Example:  "INVALID_CODE"
ageAdjustedPrice

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"
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"
moduleConsentTextBlocks array[object]

Consent texts for modules that are part of the contract

id integer(int64)

The unique identifier of the text block

Example:  1234567890
title

The title of the text block

Example:  "Title of 1. text block"
text

The text of the text block

Example:  "Text of 1. text block"
order integer(int32)

The order of the text block in the contract

Example:  1
hasSignature

Text block configuration has a signature field. You have the option to show a signature input field and it will be added in the contract document. It is not a required field in magicline. It is up to your implementation if you add this field.

showCommunicationPrivacyOptions

Text block contains information about the communication privacy options. You are advised to show a matrix with communication settings in combination with this text block.

attachmentType

Indicates the type of attachment for this block

Allowed values:
NONE No text block
FILE File information available in `attachedDocument`
URL Url information available in `attachedExternalUrlDto`
CONTRACT_PDF_PREVIEW Contract PDF preview
Example:  "CONTRACT_PDF_PREVIEW"
attachedExternalUrlDto

Represents url information.

title required

Url title

Example:  "Example Resource"
url required

Url to access the resource

Example:  "https://some-url.com"
attachedDocument

Represents document information.

fileName required

Name of the file to download

Example:  "contract.pdf"
url required

Temporary valid download link. Expires after 5 hours.

Example:  "https://some-url.com"
rateBundleModuleId integer(int64)

The ID of the associated rate bundle module. Only set if this is a module consent text block.

Example:  1234567890
confirmationRequired
selectedOptionalModulesPreviews array[object]

Optional module contract preview including discount, company split or credit, if a valid voucher code has been provided

name required

Name of the sub contract

Example:  "Sauna"
discountedPrice

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"
discountPeriods array[object]

List of discount periods for the sub contract, if a valid discount voucher code has been provided

discountType required

Type of discount (percentage or absolute)

Allowed values:
ABSOLUTE Represents an absolute discount
PERCENTAGE Represents a percentage based discount
Example:  "PERCENTAGE"
discountValue 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"
effectivePeriod required

The type of period for which this discount is applied

Allowed values:
UNLIMITED Represents a voucher with unlimited effective period
INITIAL_TERM Represents a voucher effective during the initial term of the membership
TIME_BASED Represents a voucher with a time based effective period
Example:  "TIME_BASED"
effectivePeriodTimeBasedTerm

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

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

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

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

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

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

The method that is being used to determine the period for the first payment

Allowed values:
REFERENCE_DATE NORMALIZATION_ON_CALENDAR_UNIT
Example:  "REFERENCE_DATE"
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"
voucherBonusPeriod

Represents a membership offer rate bonus period.

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"
termStrategy required

Membership offer rate bonus period term strategy.

Allowed values:
CONTRACT_START Contract start date
FIXED Fixed date
END_OF_CURRENT_TERM End of current term
START_OF_NEXT_TERM Start of next term
Example:  "CONTRACT_START"
displaySeparately

Indicates whether the bonus period should be displayed separately in the offer details

Example:  true
runtimeExtensionType required

Membership offer bonus period type.

Allowed values:
WITH_EXTENSION Period with extension
WITHOUT_EXTENSION Period without extension
Example:  "WITH_EXTENSION"
extendsCancellationPeriod

Indicates whether the bonus period extends the cancellation period

Example:  false
creditValue

Voucher credit value, if a valid credit voucher code has been provided

Example:  20
id integer(int64) required

The ID of the module

Example:  12345
paymentPreview

Represents a preview of the payment schedule for a signup process.

paymentSchedule array[object]

Payment schedule entries in chronological order

dueDate string(date)

Due date of the payment in ISO-8601 format

Example:  "2025-12-31"
description

Description of the charge

Example:  "Contract Basic"
type

Type of membership payment

Allowed values:
CONTRACT_FEE Membership contract fee
STARTER_PACKAGE Membership starter package
FLAT_FEE Flat fee
MODULE_FEE Membership module fee
BONUS_PERIOD Bonus period
Example:  "MEMBERSHIP_FEE"
amount

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

Indicates if the payment is mandatory on signing

Example:  true
dueOnSigningAmount

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