Skip to content

Check Entitlements

Check which features a license is entitled to.

Endpoint

POST /api/v1/integration/entitlements/check

Headers

HeaderRequiredValue
X-API-KeyYesYour API key
Content-TypeYesapplication/json

Request Body

json
{
  "license_key": "VX-ACME-abc123def456",
  "features": ["activations.max", "api.rate_limit", "features.export"]
}
FieldRequiredTypeDescription
license_keyYesstringThe license key
featuresYesstring[]Feature codes to check (min 1)

Response (200 OK)

json
{
  "data": {
    "entitlements": {
      "features": {
        "activations.max": { "granted": true, "value": 10 },
        "api.rate_limit": { "granted": true, "value": 5000 },
        "features.export": { "granted": false, "value": null }
      },
      "limits": {
        "activations.max": { "limit": 10, "type": "metered" },
        "api.rate_limit": { "limit": 5000, "type": "metered" }
      }
    }
  },
  "meta": {
    "request_id": "uuid",
    "api_version": "1"
  }
}

Response Fields

FieldDescription
features.{code}.grantedWhether the feature is available
features.{code}.valueThe entitlement value (number, boolean, or null)
limits.{code}.limitNumeric limit for metered entitlements
limits.{code}.typeAlways "metered" for numeric entitlements

Error Responses

CodeHTTPDescription
LICENSE.NOT_FOUND404License key not found
AUTH.INVALID_API_KEY401Invalid API key
RATE_LIMIT.EXCEEDED429Rate limit exceeded

Notes

  • Entitlements are resolved from the license's entitlements JSON field
  • A feature not present in the license returns granted: false
  • Numeric entitlement values appear in both features and limits

Built by Veltara Works