The subscription entitlement object

This object represents entitlements belonging to a subscription.

code · string · required

Unique code used to identify the feature. Max 255 characters.

Example:

"seats"

name · string | null · required

Name of the feature. Max 255 characters.

Example:

"Number of seats"

description · string | null · required

Description of the feature. Max 600 characters.

Example:

"Number of users of the account"

privileges · object[] · required

Privileges associated with this feature. Each privilege shows the plan value and any subscription override.

Show child attributes

Example:

[
  {
    "code": "max",
    "name": "Maximum",
    "value_type": "integer",
    "config": {},
    "value": 15,
    "plan_value": 10,
    "override_value": 15
  },
  {
    "code": "max_admins",
    "name": "Max Admins",
    "value_type": "integer",
    "config": {},
    "value": 5,
    "plan_value": 5,
    "override_value": null
  },
  {
    "code": "root",
    "name": "Allow root user",
    "value_type": "boolean",
    "config": {},
    "value": true,
    "plan_value": true,
    "override_value": null
  },
  {
    "code": "provider",
    "name": "SSO Provider",
    "value_type": "select",
    "value": "okta",
    "plan_value": "google",
    "override_value": "okta",
    "config": { "select_options": ["google", "okta"] }
  }
]

overrides · object · required

Example:

{ "max": 15, "provider": "okta" }