entitlement_required
Not included in the current plan
Deprecated. This code is superseded and is never emitted; it stays in the registry because registry entries are never removed.
| Used as | Top-level code, HTTP 403. |
| Retryable | no |
| Since | API version 2026-11-01 |
Extension members: entitlement.
Messages#
| Language | Title | detail template |
|---|---|---|
| en | Not included in the current plan | This is not included in the current plan. |
| de | Nicht im aktuellen Tarif enthalten | Dies ist im aktuellen Tarif nicht enthalten. |
title is fixed English text and never varies per occurrence; detail follows Accept-Language and is for people only. Clients switch on code (and detail_code or failed_preconditions[].code), never on detail. A client that does not know a code falls back to the HTTP status class.
Example#
JSON
{
"type": "https://docs.hive.clerktree.com/errors/entitlement_required",
"title": "Not included in the current plan",
"status": 403,
"detail": "This is not included in the current plan.",
"instance": "/v1/assets",
"code": "entitlement_required",
"request_id": "req_01m71xxqhkf9avn6dq2sfgzgym",
"retryable": false,
"entitlement": "commands.t3"
}