The subscription entitlement object

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

privileges.code

string

required

Unique code for the privilege.

Example:

"max"

privileges.name

string | null

required

Display name for the privilege.

Example:

"Maximum"

privileges.value_type

enum<string>

required

Data type of the privilege value. Default: string

Available options:

integer,

boolean,

string,

select

Example:

"integer"

privileges.config

object

required

Show child attributes

privileges.config.select_options

string[]

Array of string, required only when value_type is select.

Example:

["google", "okta"]

privileges.value

required

Applicable value this this subscription (override_value if set, plan_value otherwise). Type depends on the privilege's value_type.

Example:

10

privileges.plan_value

required

Value assigned to this privilege in the plan. Type depends on the privilege's value_type.

Example:

10

privileges.override_value

required

Value assigned to this subscription specifically. Type depends on the privilege's value_type. Null if no override is set.

Example:

10

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" }

API Reference