PApaypal
Entitlements

Update subscription entitlements

This endpoint performs partial updates to subscription entitlements. The entitlements in the request are combined with existing entitlements associated with the subscription (even the ones inherited from plan) that are not mentioned in the request.

patch/subscriptions/{external_subscription_id}/entitlements

Request

Path parameters

external_subscription_idstring required

The external ID of the subscription

Request body

Example request

{
  "entitlements": [
    {
      "feature_code": "USER-SEATS",
      "feature_privilege_values": {
        "rate_limit": 1000,
        "endpoints": "all"
      }
    }
  ]
}

Response

Entitlements updated successfully

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.