Skip to main content
GET
/
plans
/
{code}
/
entitlements
/
{feature_code}
Retrieve an entitlement
curl --request GET \
  --url https://api-m.paypal.com/v1/commerce/billing/plans/{code}/entitlements/{feature_code} \
  --header 'Authorization: Bearer <token>'
{
  "feature_code": "seats",
  "name": "Number of seats",
  "description": "Number of users of the account",
  "feature_privileges": [
    {
      "code": "max",
      "name": "Maximum",
      "value_type": "INTEGER",
      "value": 10
    },
    {
      "code": "max_admins",
      "name": "Max Admins",
      "value_type": "INTEGER",
      "value": 5
    },
    {
      "code": "root",
      "name": "Allow root user",
      "value_type": "BOOLEAN",
      "value": true
    },
    {
      "code": "provider",
      "name": "SSO Provider",
      "value_type": "SELECT",
      "value": "google",
      "config": {
        "select_options": [
          "google",
          "okta"
        ]
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use the /v1/oauth2/token endpoint to obtain an access token and pass it as a Bearer token in the Authorization header.

Path Parameters

​
code
string
required

The unique code of the plan

​
feature_code
string
required

The unique code of the feature

Response

Entitlement details

​
feature_code
string
required

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.

Maximum length: 255
Example:

"USER-SEATS"

​
feature_privileges
object[]
required

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.

​
name
string

Human-readable display name of the feature shown in user interfaces. More descriptive than the code and helps users understand the feature's purpose.

Maximum length: 255
Example:

"Number of seats"

​
description
string

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.

Maximum length: 600
Example:

"Number of users of the account"

⌘I