Entitlements
Get Customer Entitlements
Retrieve all feature entitlements for a customer based on their active subscriptions and credit grants. Returns deduplicated features by slug with their current values, usage data for numeric features, and credit information where applicable. Sources can be 'plan', 'override', 'default', or 'credits'.
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.
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"{
"entitlements": [
{
"entitled": true,
"feature": {
"slug": "api-access",
"value": true
},
"source": "plan",
"creditInfo": {
"creditAllowance": 0,
"creditsRemaining": 0,
"nextExpiryDate": null
}
},
{
"entitled": true,
"feature": {
"slug": "max-api-calls",
"value": 10000
},
"source": "credits",
"usages": [
{
"metricId": "met_DQ6f7a8b9c0d1e2f3g4h5i",
"usage": 2500
}
],
"creditInfo": {
"creditAllowance": 10000,
"creditsRemaining": 7500,
"nextExpiryDate": "2024-02-15T00:00:00Z"
}
}
]
}{
"error": "Failed to fetch entitlements"
}