Get the idle period configuration of the contract

Deprecated

Required Scopes: `MEMBERSHIP_SELF_SERVICE_IDLE_PERIOD_CONFIG_READ` Get the idle period configuration of the contract

Endpoint

GET /v1/memberships/{contractId}/self-service/idle-periods/config

Path Parameters

contractId required integer (int64)

Unique ID of the contract

Responses

OK

Response Body application/json

Represents the configuration of an idle period

temporalUnit required

Represents the temporal unit of an idle period

Allowed values:
DAY Represents a daily temporal unit of the idle period. Can be used for day pickers only.
WEEK Represents a weekly temporal unit of the idle period. Can be used for week pickers only. Supports only full weeks.
MONTH Represents a monthly temporal unit of the idle period. Can be used for month pickers only. Supports only full months.
Example:  "WEEK"
maxTerms integer(int32) required

Maximum count of idle period terms

Example:  6
firstPossibleStartDate string(date) required

The first possible start date of the idle period

Example:  "2023-08-01"
nextPossibleStartDateOnly required

Whether the given first possible start date of the idle period is the only allowed start date

idlePeriodFee 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"
accessRefusal required

Whether the studio access is refused for the customer during the idle period

idlePeriodReasons array[object] required

List of idle period reasons

id integer(int64) required

Unique ID of the idle period reason

Example:  203
name required

Name of the idle period reason

Example:  "Vacation"
documentRequired required

Whether the idle period reason requires a document of proof

idlePeriodCreationStatus required

Status of the amendment configuration.

Allowed values:
READ No changes to data are possible.
CHANGES_REQUIRE_VERIFICATION Data can be changed, but needs verification to be applied to the customer.
CHANGES_WITHOUT_VERIFICATION Data can be changed, will be applied to the customer with immediate effect.
Example:  "CHANGES_REQUIRE_VERIFICATION"
contractHasExtension required

Whether the idle period extends the original contract end date

unlimitedAllowed required

Whether the unlimited idle period can be created

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