On this page
No Headings
Request payload for creating a new feature. Features represent entitleable capabilities that can be assigned to customers through plans.
objectcodestring^[a-zA-Z0-9_-]+$Unique identifier for the feature across your entire system. This code is used when creating entitlements and should represent the feature's function (e.g., 'seats', 'api-access', 'API_STORAGE'). Allows alphanumeric characters, underscores, and hyphens.
namestringCustomer-facing name of the feature that clearly describes what functionality or capability it provides. This name appears in billing interfaces and customer portals.
descriptionstringDetailed explanation of what this feature provides, its limitations, and how it affects the customer's experience.
privilegesarrayList of configurable privileges that define what aspects of this feature can be customized when creating entitlements. Each privilege can have different values assigned in different plans or subscriptions. Can be empty if the feature is simply on/off.
itemsobjectDefines a configurable aspect of a feature that can be assigned different values when entitled to plans or subscriptions
coderequiredstring^[a-zA-Z0-9_-]+$Unique identifier for the privilege within its parent feature. Used as a key when assigning values to this privilege in entitlements. Allows alphanumeric characters, underscores, and hyphens.
namestringHuman-friendly display name for the privilege shown in user interfaces. This helps users understand what aspect of the feature is being configured.
value_typestring"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.
itemsstring