Skip to main content

Write an organization's entitlements as an admin override (super admin)

PUT 
/api/v1/system/entitlements/:org

Writes a complete admin-sourced row (whole-row only; there are no per-field overrides). The request body's source is ignored — a super admin write is always admin, so a body claiming to be the billing service cannot launder itself past the precedence rule.

Because the row is complete, an admin row resolves whole-row: a null cap means unlimited, not "inherit the deployment default". That is what makes the editor's Unlimited switch mean what it says on a SaaS deployment, where every default is a real number. whiteLabel is the exception — being a boolean, its null keeps meaning "use the deployment default".

While the stored row is admin-sourced, billing pushes to PUT /api/v1/orgs/{org}/entitlements are accepted with 200 but NOT applied (applied: false, suppressedBy: admin) and recorded in the audit log. Use DELETE on this path to release the override.

An optional X-Entitlements-Reason header is stored on the audit row.

Request​

Responses​

Updated entitlements