PATCH
/
plans
/
{code}
/
entitlements
Partial update of an entitlement
curl --request PATCH \
  --url https://api.getlago.com/api/v1/plans/{code}/entitlements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "seats": {
    "max": 20,
    "max_admins": 10,
    "root": false
  },
  "sso": {
    "provider": "okta"
  }
}'
{
  "entitlement": {
    "code": "seats",
    "name": "Number of seats",
    "description": "Number of users of the account",
    "privileges": [
      {
        "code": "max",
        "name": "Maximum",
        "value_type": "integer",
        "value": 10
      },
      {
        "code": "max_admins",
        "name": "Max Admins",
        "value_type": "integer",
        "value": 5
      },
      {
        "code": "root",
        "name": "Allow root user",
        "value_type": "boolean",
        "value": true
      },
      {
        "code": "provider",
        "name": "SSO Provider",
        "value_type": "select",
        "value": "google",
        "config": {
          "select_options": [
            "google",
            "okta"
          ]
        }
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
code
string
required

Code of the existing plan.

Example:

"startup"

Body

application/json · object

Entitlement payload

Feature entitlements with their privilege values. Each key is a feature code, and the value is an object containing privilege codes with their associated values.

Response

200
application/json

Entitlement updated

The response is of type object.