PApaypal
Entitlements

Retrieve an entitlement

Get details of a specific entitlement for a plan

get/plans/{plan_code}/entitlements/{feature_code}

Request

Path parameters

plan_codestring required

The unique code of the plan

feature_codestring required

The unique code of the feature

Response

Entitlement details

feature_codestring 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.

namestring

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

descriptionstring

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.

Example response

{
  "feature_code": "USER-SEATS",
  "name": "Number of seats",
  "description": "Number of users of the account",
  "feature_privileges": [
    {
      "code": "max",
      "name": "Maximum",
      "value_type": "INTEGER",
      "config": {
        "select_options": [
          "google",
          "okta",
          "azure"
        ]
      },
      "value": 100
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.