On this page
No Headings
feature_coderequiredstring^[a-zA-Z0-9_-]+$Unique code used to identify the feature across the system. This serves as the primary identifier when assigning entitlements to plans and must be unique.
namestringHuman-readable display name of the feature shown in user interfaces. More descriptive than the code and helps users understand the feature's purpose.
descriptionstringComprehensive explanation of what this feature provides to customers, how it works, and any important usage information. This helps users understand the value and functionality of the feature.
feature_privilegesrequiredarrayCollection of privilege settings with both plan values and subscription-specific overrides. Each privilege shows the effective value applied to this subscription, with details about which values come from the plan and which are overridden.
itemsobjectcoderequiredstring^[a-zA-Z0-9_-]+$Unique identifier for this specific privilege within the feature. Used as a key when setting privilege values.
namestringUser-friendly display name for this privilege shown in interfaces. More descriptive than the code and helps users understand what this specific setting controls.
value_typerequiredstring"STRING", "BOOLEAN", "INTEGER", "SELECT""STRING"Defines the data type that this privilege accepts when being assigned values in entitlements. 'INTEGER' for numeric limits, 'BOOLEAN' for on/off toggles, 'STRING' for text values, 'SELECT' for predefined options.
configobjectAdditional configuration for privileges that require constraints or options. Currently used for 'select' type privileges to define allowed values.
select_optionsarrayDefines the allowed values when value_type is 'select'. When creating entitlements, only these predefined options can be assigned. Useful for features like SSO providers, regions, or service tiers.
itemsstringvaluerequiredThe effective value for this privilege that will be applied. This is the final value after considering both plan and override values.
plan_valuerequiredThe default value from the subscription's plan. This value applies when no override is set.
override_valuerequiredThe subscription-specific override value, if one exists. If null, the plan value is being used.