Seats
Get Seat Usage
Get the current seat usage for a customer's active subscription. Returns per-component seat usage, pending removals, subscription details, and price components.
Authorization
bearerAuth AuthorizationBearer <token>
Use your secret API key as the bearer token
In: header
Path Parameters
customerId*string
Customer ID
Match
^cus_[A-Za-z0-9]{22}$Response Body
application/json
application/json
application/json
curl -X GET "https://api.getlumen.dev/v1/seats/usage/string"{
"customerId": "cus_01j23abc456def789ghi0jklm",
"subscriptionId": "sub_int_Z2e7iq9Y3m1RpAJcGxK8bB",
"seatUsages": [
{
"componentId": "price_comp_unit_R4b2Xk9Pq3s7Lm1a8n0d5c",
"componentName": "Seats",
"unitLabel": "seat",
"metricId": "met_8fQ9rGzK3pV1sR6tB0nM",
"currentUsage": 12,
"pendingRemovals": 1,
"unitAmountCents": 2500
}
],
"subscriptionDetails": [
{
"subscriptionId": "sub_int_Z2e7iq9Y3m1RpAJcGxK8bB",
"componentId": "price_comp_unit_R4b2Xk9Pq3s7Lm1a8n0d5c",
"previousBillingDate": "2025-02-01T00:00:00.000Z",
"nextBillingDate": "2025-03-01T00:00:00.000Z",
"createdAt": "2025-02-01T00:00:00.000Z",
"updatedAt": "2025-02-15T12:00:00.000Z"
}
],
"priceComponents": [
{
"type": "per_unit",
"component_id": "price_comp_unit_R4b2Xk9Pq3s7Lm1a8n0d5c",
"component_name": "Seats",
"unit_label": "seat",
"amount_cents": 2500,
"metric_id": "met_8fQ9rGzK3pV1sR6tB0nM",
"bill_immediately": true
}
]
}{
"error": "Customer not found"
}{
"error": "Failed to get seat usage"
}