What the tenant's plan currently allows

GET

/entitlements

const url = 'https://api.flotera.com/api/v1/entitlements';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-erm_session=<__Host-erm_session>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.flotera.com/api/v1/entitlements \
  --cookie __Host-erm_session=<__Host-erm_session>

Resolved capability snapshot: plan matrix plus auditable tenant overrides, deny by default for unknown keys (13 §3.3).

The matrix does not shrink while an account is frozen: a frozen tenant still sees the capabilities it pays for, and account_state explains that they are suspended. Telling the user “your plan does not include X” when the plan does include it would be a lie.

Authorizations

sessionCookie

Responses

200

Entitlement snapshot.

application/json

object

plan

required

Any of:

string
null

Internal catalog code. Not the public label — labels are not unique.

string

<= 64 characters /^[a-z][a-z0-9_-]{1,63}$/

public_label

string | null

<= 64 characters

account_state

required

Why a capability the plan grants may still be refused right now. The capability list itself is unaffected by the lifecycle.

string

Allowed values: active grace frozen

capabilities

required

Array<object>

<= 128 items

object

key

required

Entitlement key from 13 §3.3, e.g. fleet.servers.max.

string

<= 64 characters

value

required

Any of:

boolean

unlimited

True when an integer limit is explicitly unbounded.

boolean

defects

Catalog or override rows that could not be read. Each one denies its own key and nothing else — one broken row must not take the wallet down. Non-empty is an operator alert, not a client error.

Array<object>

<= 64 items

object

key

required

string

<= 64 characters

reason

required

string

<= 256 characters

subscription_version

Monotonic resource version used for ETag/If-Match.

integer

resolved_at

required

RFC 3339 UTC with microsecond precision.

string format: date-time

Example

{
  "account_state": "active",
  "resolved_at": "2026-07-25T10:15:30.123456Z"
}

401

Missing/invalid credentials (code=unauthorized).

application/problem+json

RFC 9457 problem document with a stable machine code.

object

type

required

string format: uri

title

required

string

<= 256 characters

status

required

integer

>= 100 <= 599

code

required

Stable machine-readable error code (03 §2.4).

string

Allowed values: unauthorized forbidden csrf_rejected not_found conflict idempotency_conflict validation_failed rate_limited payload_too_large unsupported_agent_version temporarily_unavailable offline_queue_full online_queue_full plan_required server_limit_reached feature_not_entitled account_in_grace account_frozen payment_pending payment_expired payment_amount_mismatch change_already_pending change_already_applied change_effective reserve_not_covered direction_changed

detail

string

<= 2048 characters

instance

string

<= 512 characters

request_id

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

errors

Array<object>

<= 100 items

object

path

required

JSON Pointer to the offending field.

string

<= 512 characters

code

required

string

<= 64 characters

Example

{
  "type": "https://ermeon.com/problems/validation",
  "code": "unauthorized"
}

403

Authenticated but not permitted. code=forbidden — role/scope mismatch; code=feature_not_entitled — the plan does not include the capability; code=account_frozen — the account is frozen and this operation is declared x-ermeon-frozen: deny. The three are deliberately distinct: only the last one is fixed by a top-up (13 §5.6).

application/problem+json

RFC 9457 problem document with a stable machine code.

object

type

required

string format: uri

title

required

string

<= 256 characters

status

required

integer

>= 100 <= 599

code

required

Stable machine-readable error code (03 §2.4).

string

detail

string

<= 2048 characters

instance

string

<= 512 characters

request_id

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

errors

Array<object>

<= 100 items

object

path

required

JSON Pointer to the offending field.

string

<= 512 characters

code

required

string

<= 64 characters

Example

{
  "type": "https://ermeon.com/problems/validation",
  "code": "unauthorized"
}

503

A dependency the endpoint needs is not configured or is temporarily unavailable (code=unavailable). The rest of the API keeps working — an absent external integration must not take the service down.

application/problem+json

RFC 9457 problem document with a stable machine code.

object

type

required

string format: uri

title

required

string

<= 256 characters

status

required

integer

>= 100 <= 599

code

required

Stable machine-readable error code (03 §2.4).

string

detail

string

<= 2048 characters

instance

string

<= 512 characters

request_id

UUID (v7 for new entities; v4 accepted during migration).

string format: uuid

errors

Array<object>

<= 100 items

object

path

required

JSON Pointer to the offending field.

string

<= 512 characters

code

required

string

<= 64 characters

Example

{
  "type": "https://ermeon.com/problems/validation",
  "code": "unauthorized"
}