Skip to main content
GET
/
subscriptions
/
{external_subscription_id}
/
entitlements
List all subscription entitlements
curl --request GET \
  --url https://api-m.sandbox.paypal.com/v1/commerce/billing/subscriptions/{external_subscription_id}/entitlements \
  --header 'Authorization: Bearer <token>'
{
  "entitlements": [
    {
      "feature_code": "seats",
      "name": "Number of seats",
      "description": "Number of users of the account",
      "feature_privileges": [
        {
          "code": "max",
          "name": "Maximum",
          "value_type": "INTEGER",
          "value": 15,
          "plan_value": 10,
          "override_value": 15
        },
        {
          "code": "max_admins",
          "name": "Max Admins",
          "value_type": "INTEGER",
          "value": 5,
          "plan_value": 5,
          "override_value": null
        },
        {
          "code": "root",
          "name": "Allow root user",
          "value_type": "BOOLEAN",
          "value": true,
          "plan_value": true,
          "override_value": null
        },
        {
          "code": "provider",
          "name": "SSO Provider",
          "value_type": "SELECT",
          "value": "okta",
          "plan_value": "google",
          "override_value": "okta",
          "config": {
            "select_options": [
              "google",
              "okta"
            ]
          }
        }
      ]
    },
    {
      "feature_code": "api_access",
      "name": "API Access",
      "description": "Access to REST API endpoints",
      "feature_privileges": [
        {
          "code": "rate_limit",
          "name": "API Rate Limit",
          "value_type": "INTEGER",
          "value": 10000,
          "plan_value": 10000,
          "override_value": null
        },
        {
          "code": "endpoints",
          "name": "Available Endpoints",
          "value_type": "SELECT",
          "value": "all",
          "plan_value": "all",
          "override_value": null,
          "config": {
            "select_options": [
              "basic",
              "standard",
              "premium",
              "all"
            ]
          }
        }
      ]
    }
  ]
}

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

​
external_subscription_id
string
required

The external ID of the subscription

Response

Effective entitlements for the subscription

​
entitlements
object[]
required

List of effective entitlements for the subscription, showing both plan values and subscription-specific overrides