Entitlements

Get Account Entitlements

client.accounts.entitlements.list(, ?): SinglePage<EntitlementListResponse { id, allocation, created_date, 3 more } >

GET/accounts/{account_id}/entitlements

ModelsExpand Collapse

EntitlementListResponse { id, allocation, created_date, 3 more }

A single entitlement record for a zone or account.

id: string

Entitlement identifier — equal to the feature key.

allocation: Allocation { type, value }

Represents the allocation value for an entitlement. The shape of value depends on type: bool uses a boolean, max_count uses an integer, enum_number uses an array of numbers, range uses an object with min and max integer fields, and string uses a string.

type: "bool" | "max_count" | "enum_number" | 2 more

Allocation type discriminator.

One of the following:

"bool"

"max_count"

"enum_number"

"range"

"string"

value: boolean | number | string | 2 more

Contains the allocation value whose concrete type the type field determines: bool yields a boolean, max_count yields an integer, enum_number yields an array of numbers, range yields an object with min and max, and string yields a string.

One of the following:

boolean

number

string

Array<number>

UnionMember4 { max, min }

max: number

min: number

created_date: string

ISO 8601 timestamp (microsecond precision, no timezone offset) when the entitlement was created. Format: YYYY-MM-DDTHH:MM:SS.ffffff.

deleted_date: string

ISO 8601 timestamp when the entitlement was deleted, or empty string if not deleted.

edited_date: string

ISO 8601 timestamp (microsecond precision, no timezone offset) when the entitlement was last edited.

feature: Feature { id, feature_set, key, name }

Describes a product feature associated with an entitlement.

id: number

Numeric identifier of the feature.

formatint64

feature_set: string

The logical grouping (set) this feature belongs to.

key: string

Unique string key for the feature.

name: string

Human-readable name of the feature.