Get the idle period configuration of the contract

Required Scopes: MEMBERSHIP_SELF_SERVICE_IDLE_PERIOD_CONFIG_READ

SecurityApiKeyAuth

Request

path Parameters

contractId

required

integer <int64>

Unique ID of the contract

Responses

200

400

Validation of the request failed.

401

Authentication failed. No api-key, wrong api-key or wrong header name.

403

Authorization failed. The caller has no privilege to the given resource.

404

Entity does not exists.

409

Conflict

429

Access denied - rate limit is exceeded.

500

Unexpected system error.

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

Request samples

curl

Response samples

application/json

{"temporalUnit": "WEEK",
"maxTerms": 6,
"firstPossibleStartDate": "2023-08-01",
"nextPossibleStartDateOnly": true,
"idlePeriodFee": {"amount": 20,
"currency": "EUR"
},
"accessRefusal": true,
"idlePeriodReasons": [{"id": 203,
"name": "Vacation",
"documentRequired": true
}
],
"idlePeriodCreationStatus": "CHANGES_REQUIRE_VERIFICATION",
"contractHasExtension": true
}