If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more
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.
Match^[a-zA-Z0-9_-]+$Length0 <= length <= 255
namestringOptional
Human-readable display name of the feature shown in user interfaces. More descriptive than the code and helps users understand the feature's purpose.
Length0 <= length <= 255
descriptionstringOptional
Comprehensive 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.
Collection of configurable privilege settings associated with this feature entitlement. Each privilege defines a specific capability, setting, or limit (e.g., maximum users, access level, enabled/disabled status) that can be assigned values in the plan. These privileges determine what capabilities customers receive with this feature.
PlanEntitlementPrivilege properties
5 properties
codestringRequired
Unique identifier for this specific privilege within the feature. Used as a key when setting privilege values.
Match^[a-zA-Z0-9_-]+$Length0 <= length <= 255
namestringOptional
User-friendly display name for this privilege shown in interfaces. More descriptive than the code and helps users understand what this specific setting controls.
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.
Additional configuration for privileges that require constraints or options. Currently used for 'select' type privileges to define allowed values.
PrivilegeConfig properties
1 property
select_optionsarray<string>Optional
Defines 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.
valueRequired
The specific value assigned to this privilege in the plan. The type of value must match the value_type field. For integer types, this represents numeric limits (e.g., 100 users); for boolean types, true/false settings (e.g., enable/disable features); for string or select types, specific configuration options (e.g., 'premium', 'basic').