402 Payment Required

Not included in the plan

Code

entitlement_required

Status

402 Payment Required

Type

https://errors.clavian.io/entitlement-required

What it means

The organisation’s subscription does not include what this request needs, such as a module, more stations or a setting that depends on one.

What to do

Do not retry. Say that the organisation’s plan does not include it.

Example

The API answers with status 402 and this body, as application/problem+json. A detail may be added, saying what went wrong this time; it is for people, and changes.

{
  "type": "https://errors.clavian.io/entitlement-required",
  "title": "Not included in the plan",
  "status": 402,
  "code": "entitlement_required",
  "requestId": "req_01k5znw4hmfay8vvr14d2pf2db"
}

Endpoints that return it

From the OpenAPI document, every endpoint that names it among its answers:

• PUT /v1/organizations/{organizationId}/settingsChange the organisation’s settings
• PUT /v1/organizations/{organizationId}/venues/{venueId}/settingsChange a venue’s settings