Entitlements
Get Organization Entitlements (Seat-Aware)
Retrieve all feature entitlements for all customers in the same organization as the specified customer. Returns entitlements for each customer in the organization with their internal and external customer IDs. Falls back to single-customer entitlements if customer has no organization.
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/seat-aware"{
"entitlements": [
{
"entitled": true,
"feature": {
"slug": "team-seats",
"value": 10
},
"source": "plan",
"customerId": "cus_Lo4xGg1Yk9pB2eWv3sNtA",
"externalCustomerId": "user_123",
"creditInfo": {
"creditAllowance": 0,
"creditsRemaining": 0,
"nextExpiryDate": null
}
},
{
"entitled": true,
"feature": {
"slug": "team-seats",
"value": 10
},
"source": "plan",
"customerId": "cus_Mn5yHh2Zl0qC3fXw4tOuB",
"externalCustomerId": "user_456",
"creditInfo": {
"creditAllowance": 0,
"creditsRemaining": 0,
"nextExpiryDate": null
}
}
]
}{
"error": "Failed to fetch seat-aware entitlements"
}