PApaypal
Entitlements

Create an entitlement

Assign a feature to a plan with specific privilege values. This action removes all current entitlements and replaces with the new ones provided. To retain existing entitlements while adding new ones, apply a PATCH request.

post/plans/{plan_code}/entitlements

Request

Path parameters

plan_codestring required

The unique code of the plan

Request body

Example request

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

Response

Entitlements created 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": 100
        }
      ]
    }
  ]
}

Changes

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