PLAN_ENTITLEMENT_REQUIRED

Not included in the organisation's plan

HTTP status 403 Forbidden, code PLAN_ENTITLEMENT_REQUIRED.

What it means#

The organisation's plan does not include what the operation would create. It is a policy check on the plan, not on the caller: every credential for the organisation gets the same answer. The body names the entitlement that was missing and the plan the organisation is on. GET /plan reports every entitlement, so a client can find this out before asking. A plan never takes away what already exists, so this is only ever raised when something new is created.

What to do#

Use what the plan includes instead (the message says what that is), or move the organisation to a plan that includes it. Retrying will not change the answer.

On the wire#

Every error response carrying this code names this page in error.moreInfo, with the request id in the query string. See Error codes for the response shape and the list of every code.