v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB
entitlements

Retrieve an entitlement

This endpoint retrieves a specific entitlement for a plan.

get/plans/{code}/entitlements/{feature_code}

Response

Entitlement

Example response

{
  "entitlement": {
    "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"
          ]
        }
      }
    ]
  }
}