Check Entitlements
Check which features a license is entitled to.
Endpoint
POST /api/v1/integration/entitlements/checkHeaders
| Header | Required | Value |
|---|---|---|
X-API-Key | Yes | Your API key |
Content-Type | Yes | application/json |
Request Body
json
{
"license_key": "VX-ACME-abc123def456",
"features": ["activations.max", "api.rate_limit", "features.export"]
}| Field | Required | Type | Description |
|---|---|---|---|
license_key | Yes | string | The license key |
features | Yes | string[] | 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
| Field | Description |
|---|---|
features.{code}.granted | Whether the feature is available |
features.{code}.value | The entitlement value (number, boolean, or null) |
limits.{code}.limit | Numeric limit for metered entitlements |
limits.{code}.type | Always "metered" for numeric entitlements |
Error Responses
| Code | HTTP | Description |
|---|---|---|
LICENSE.NOT_FOUND | 404 | License key not found |
AUTH.INVALID_API_KEY | 401 | Invalid API key |
RATE_LIMIT.EXCEEDED | 429 | Rate limit exceeded |
Notes
- Entitlements are resolved from the license's
entitlementsJSON field - A feature not present in the license returns
granted: false - Numeric entitlement values appear in both
featuresandlimits