Plan, message credits used against the monthly allowance, subscription status, and days until the period resets. Requires the read:usage permission.
Authorization
BearerAuth read:usageAuthorizationBearer <token>
In: header
Scope: read:usage
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/usage"{
"plan": {
"id": "growth",
"name": "Growth"
},
"usage": {
"messagesUsed": 1240,
"messagesLimit": 5000,
"percentUsed": 25
},
"subscription": {
"status": "active",
"billingInterval": "month",
"currentPeriodEnd": "2026-08-28T00:00:00.000Z",
"cancelAtPeriodEnd": false
},
"daysUntilReset": 24
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}