Entitlements
Check Feature Entitlement
Check if a customer is entitled to a specific feature. Returns detailed entitlement information including the feature value, source (plan/override/credits), usage metrics for numeric features, and credit information. For numeric features with credits, entitled is determined by comparing usage against credit allowance.
Authorization
bearerAuth AuthorizationBearer <token>
Use your secret API key as the bearer token
In: header
Path Parameters
customerId*string
Customer ID. Can be internal ID (cus_...) or external ID based on isExtCustId parameter.
featureSlug*string
Feature slug to check
Match
^[a-z0-9-]+$Query Parameters
isExtCustId?string
When 'true', customerId is interpreted as externalCustomerId (your external ID). Default is 'false' (internal Lumen customer ID).
Default
"false"Value in
"true" | "false"Response Body
application/json
application/json
curl -X GET "https://api.getlumen.dev/v1/entitlements/cus_Lo4xGg1Yk9pB2eWv3sNtA/feature/api-access"{
"entitled": true,
"feature": {
"slug": "api-access",
"value": true
},
"source": "plan",
"creditInfo": {
"creditAllowance": 0,
"creditsRemaining": 0,
"nextExpiryDate": null
}
}{
"error": "Failed to check entitlement"
}