402 Payment Required
Not included in the plan
- Code
entitlement_required- Status
402Payment 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
36 endpoints in the OpenAPI document name it among their answers.
All 36 endpoints
GET /v1/boot-server/configThe boot server’s signed config and licence leaseGET /v1/boot-server/releaseThe boot server release current on this server’s channelPUT /v1/organizations/{organizationId}/settingsChange the organisation’s settingsGET /v1/organizations/{organizationId}/venues/{venueId}/boot/classesWhat each station class’s PCs bootPUT /v1/organizations/{organizationId}/venues/{venueId}/boot/classes/{classId}Set what a station class’s PCs bootPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/edits/{editId}/discardDiscard an editPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/edits/{editId}/publishPublish an edit as a new versionGET /v1/organizations/{organizationId}/venues/{venueId}/boot/floorBoot state of the PCs on the FloorGET /v1/organizations/{organizationId}/venues/{venueId}/boot/floor-statesThe simple boot state of the PCs on the FloorGET /v1/organizations/{organizationId}/venues/{venueId}/boot/imagesThe venue’s images and game disksPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/imagesA new image: capture it from a reference PC, import one, or make a game disk from a folderPATCH /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}Change an imagePOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/editsEdit an image on one PCPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/make-independentMake an image saved from another independentPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/mergeMerge old versions into a new basePOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/preparePrepare a version againPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/restoreMake an earlier version current againPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/server-editsUpdate a game disk on the boot serverGET /v1/organizations/{organizationId}/venues/{venueId}/boot/images/{imageId}/versionsAn image’s versions: its restore pointsGET /v1/organizations/{organizationId}/venues/{venueId}/boot/metricsBoot health: per-PC read latency, cache hits, bytes; server uplink and disk queueGET /v1/organizations/{organizationId}/venues/{venueId}/boot/new-pcsPCs that start from the boot server and are not stations yetGET /v1/organizations/{organizationId}/venues/{venueId}/boot/pcsThe venue’s boot PCsPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/pcsAdd a boot PC by its MACPATCH /v1/organizations/{organizationId}/venues/{venueId}/boot/pcs/{bootPcId}Assign a boot PCPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/pcs/{bootPcId}/identifyShow a large number on a boot PC’s own screenPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/pcs/{bootPcId}/make-stationMake a new PC a station on the FloorPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/pcs/{bootPcId}/removeRemove a boot PCPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/pcs/{bootPcId}/shader-seedMake a PC’s shader cache its GPU family’s seedPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/rollouts/restart-idleRestart idle PCs onto the current versionGET /v1/organizations/{organizationId}/venues/{venueId}/boot/serversThe venue’s boot serverPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/servers/pairing-codeA pairing code for the venue’s boot serverPATCH /v1/organizations/{organizationId}/venues/{venueId}/boot/servers/{bootServerId}Rename a boot serverPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/servers/{bootServerId}/unpairUnpair a boot serverPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/servers/{bootServerId}/updateInstall the boot server’s downloaded update nowPOST /v1/organizations/{organizationId}/venues/{venueId}/boot/wipesForce-wipe write-back or shader cachesPUT /v1/organizations/{organizationId}/venues/{venueId}/settingsChange a venue’s settings