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
List of effective entitlements for the subscription, showing both plan values and subscription-specific overrides
SubscriptionEntitlementResponse properties
4 properties
feature_codestringRequired
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 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.
EntitlementPrivilegeOverride properties
7 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 effective value for this privilege that will be applied. This is the final value after considering both plan and override values.
plan_valueRequired
The default value from the subscription's plan. This value applies when no override is set.
override_valueRequired
The subscription-specific override value, if one exists. If null, the plan value is being used.