Sign up a new membership

Deprecated

Required Scopes: `MEMBERSHIP_WRITE` Returns customer id within the result dto.

Endpoint

POST /v1/memberships/signup

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

The result of the membership signup

customerId integer(int64) required

Unique ID of the customer

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