---
title: "Retrieve an entitlement"
method: GET
path: "/plans/{plan_code}/entitlements/{feature_code}"
tags: ["Entitlements"]
---

# Retrieve an entitlement

`GET /plans/{plan_code}/entitlements/{feature_code}`

## Request

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

Get details of a specific entitlement for a plan

## Path parameters

- `plan_code` string, required
- `feature_code` string, required

## Response `200`

Entitlement details

- PlanEntitlementResponse
  - `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` PlanEntitlementPrivilege[], 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.
    - `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

## 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)