List plan entitlements

This endpoint retrieves all entitlements for a specific plan.

GET /plans/{code}/entitlements

List all entitlements

cURL

curl --request GET \
  --url https://api.getlago.com/api/v1/plans/{code}/entitlements \
  --header 'Authorization: Bearer <token>'

200

{
  "entitlements": [
    {
      "code": "seats",
      "name": "Number of seats",
      "description": "Number of users of the account",
      "privileges": [
        {
          "code": "max",
          "name": "Maximum",
          "value_type": "integer",
          "config": {},
          "value": 10
        },
        {
          "code": "max_admins",
          "name": "Max Admins",
          "value_type": "integer",
          "config": {},
          "value": 5
        },
        {
          "code": "root",
          "name": "Allow root user",
          "value_type": "boolean",
          "config": {},
          "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"

Response

200

application/json

List of entitlements

entitlements · object[] · required

Show child attributes