---
title: "List all subscription entitlements"
method: GET
path: "/subscriptions/{external_subscription_id}/entitlements"
tags: ["Entitlements"]
---

# List all subscription entitlements

`GET /subscriptions/{external_subscription_id}/entitlements`

## Request

- Base URL: `https://api-m.sandbox.paypal.com`
- URL: `https://api-m.sandbox.paypal.com/subscriptions/{external_subscription_id}/entitlements`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/oauth-proxy` scopes: `read`, `write`
- TypeScript: <https://skmtc.dev/paypal/apis/usage-based-billing-api/docs/subscriptions/:external_subscription_id/entitlements/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve effective entitlements for a subscription, including plan defaults and subscription-specific overrides

## Path parameters

- `external_subscription_id` string, required

## Response `200`

Effective entitlements for the subscription

- SubscriptionEntitlementListResponse
  - `entitlements` SubscriptionEntitlementResponse[], required: List of effective entitlements for the subscription, showing both plan values and subscription-specific overrides
    - `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.
    - `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.
    - `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.
    - `feature_privileges` object[], required: 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.
      - `code` string, required: Unique identifier for this specific privilege within the feature. Used as a key when setting privilege values.
      - `name` string: User-friendly display name for this privilege shown in interfaces. More descriptive than the code and helps users understand what this specific setting controls.
      - `value_type` 'STRING' | 'BOOLEAN' | 'INTEGER' | 'SELECT', required: 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.
      - `config` PrivilegeConfig: Additional configuration for privileges that require constraints or options. Currently used for 'select' type privileges to define allowed values.
        - `select_options` string[]: 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.
      - `value` unknown, required
      - `plan_value` unknown, required
      - `override_value` unknown, required

## Other responses

- `404`: Resource Not Found.
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/paypal/apis/usage-based-billing-api.md) - [All operations](https://skmtc.dev/paypal/apis/usage-based-billing-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paypal/apis/usage-based-billing-api/revisions/22fb46514ac4?raw)