Sign up a new membership
DeprecatedRequired Scopes: `MEMBERSHIP_WRITE` Returns customer id within the result dto.
Endpoint
/v1/memberships/signup Request Body application/json
requiredThe 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
1000 startDate string(date) required The start date of the contract
"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.
"2026-01-01" notes The notes related to the contract
"Some notes" thirdPartyId Unique ID of the third party contract in the third party system
"1000a" employeeId integer(int64) Unique ID of the employee who created the membership
1239812733 referralCode Referral code to link with recruiter
"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.
"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.
123 customer required The customer information used for the membership signup
thirdPartyId Unique ID of the third party customer in the third party system
"A1000" firstName required First name of the customer
"Peter" secondFirstName Second first name of the customer
"Thomas" lastName required Last name of the customer
"Muller" secondLastName Second last name of the customer
"Meyer" dateOfBirth string(date) required Date of birth of the customer
"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.com" gender Gender of the customer
MALE | Male gender of the customer |
FEMALE | Female gender of the customer |
UNISEX | Unisex gender of the customer |
"MALE" phoneNumberPrivate Private phone number of the customer
"+44123456789" phoneNumberMobile Mobile phone number of the customer
"+44987654321" street required Street of the customer's address
"Raboisen Street" secondStreet Second street line of the customer's address
"Second Street" cityPart City part of the customer's address
"Tegel" district District of the customer's address
"District 12" streetType Street type of the customer's address
"Avenue" streetBlock Street block of the customer's address
"5th block" portal Portal of the customer's address
"Portal 1" stairway Stairway of the customer's address
"Right stairway" door Door of the customer's address
"Door 1" province Province of the customer's address
"Champagne" additionalAddressInformation Additional address information of the customer's address
"Additional information" floor Floor of the customer's address
"2nd floor" language required Basic language information
languageCode string(ISO 639-1) required The language code
"de" countryCode string(ISO 3166-1) The country code
"DE" houseNumber House number of the customer's address
"3-4" buildingName Building name
"Empire State Building" city required City of the customer's address
"Hamburg" zipCode required Zip code of the customer's address
"220-99" countryCode string(ISO 3166-1) required Country code of the customer's address
"DE" taxId Required if the studio is located in Spain or Italy. Alternatively, a valid document identification can be provided.
"12345678A" communicationPreferences array[object] List of communication preferences for the customer
messageCategory The message category of the communication preference
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 |
"CONTRACT" channels array[object] The communication channels related to the message category of the communication preference
communicationChannel required The communication channel
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 |
"EMAIL" customerOverridable Indicates if the customer can override the communication channel
true active Indicates if the communication channel is active
true documentIdentification Information from an official document that identifies the customer
documentNumber required Document number
"CX5432112345DS" documentType required Type of the document
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 |
"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
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
Response Body application/json
The result of the membership signup
customerId integer(int64) required Unique ID of the customer
1000 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 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
"parent.child" 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 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
"parent.child" 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 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
"parent.child" 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 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
"parent.child" 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 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
"parent.child" 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 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
"parent.child" 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 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
"parent.child"