PApaypal
Entitlements

List all subscription entitlements

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

get/subscriptions/{external_subscription_id}/entitlements

Request

Path parameters

external_subscription_idstring required

The external ID of the subscription

Response

Effective entitlements for the subscription

Example response

{
  "entitlements": [
    {
      "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": 15,
          "plan_value": 10,
          "override_value": 15
        }
      ]
    }
  ]
}

Changes

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