API Reference

Endpoint

GET /v1/memberships/{customerId}/self-service/contract-data

Path Parameters

customerId required integer (int64)

Unique ID of the customer

Responses

Response Body application/json

id integer(int64) required

Id of the contract

Example: 1000

startDate string(date) required

Start date of the contract

Example: "2022-01-15"

endDate string(date) required

End date of the contract

Example: "2025-10-15"

rateName required

Name of the contract rate

Example: "Premium"

contractStatus required

The contracts desired or current status

Allowed values:

`ACTIVE`	Identifies active contracts
`INACTIVE`	Identifies inactive contracts

Example: "ACTIVE"

cancelationPeriod

Represents a time period

periodValue integer(int32) required

Defines how many units a given period lasts

Example: 10

periodUnit required

Unit of the period

Allowed values:

`DAY`	Represents a day unit
`WEEK`	Represents a week unit
`MONTH`	Represents month unit
`YEAR`	Represents year unit

Example: "DAY"

cancelationStatus required

Cancelation status of the contract cancelation

Allowed values:

`CANCELED`	The contract was canceled by the customer.
`PENDING_VERIFICATION`	The cancelation is pending verification.
`PENDING_WITHDRAWAL_VERIFICATION`	The cancelation withdrawal is pending verification.

Example: "PENDING_VERIFICATION"

cancelationDate string(date)

Date the cancelation of the contract was or will be canceled

Example: "2023-01-25"

cancelationReason

Name of the reason why the contract was canceled

Example: "Officially ordered studio closure"

price required deprecated

Base price of the contract

Example: 19.9

priceDetails required

Price details of the contract

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"

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

paymentFrequency required

Represents the payment frequency of a contract

id integer(int64)

Unique ID of the payment frequency of a contract

Example: 203

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"

lastPossibleCancelationDate string(date)

Latest date the contract can be canceled

Example: "2023-01-25"

availableCancelationDates array[string(date)]

dates the contract can be canceled to

Example: ["2023-01-25","2023-02-25"]

cancelationOrigin

Cancelation origin of the contract cancelation

Allowed values:

`STUDIO`	The contract was canceled by the studio. This includes also dunning, contract switch, import, contract voucher withdraw and member cash purchase limit rejection origins.
`CUSTOMER`	The contract was canceled by the customer.

Example: "CUSTOMER"

rateCodes array[object]

Rate codes of this contract

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:

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:

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:

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:

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:

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:

reference

Reference to validation error

Example: "parent.child"