GET
/
v3
/
billing
/
usage-stats
Get Usage Stats
curl --request GET \
  --url http://127.0.0.1:3333/v3/billing/usage-stats \
  --header 'Authorization: Bearer <token>'
{
  "totalSessions": 123,
  "webSessions": 123,
  "whatsappSessions": 123,
  "aiResponses": 123,
  "totalCreditsConsumed": 123,
  "creditsUsedThisMonth": 123,
  "plan": "HOBBY",
  "creditsRecurring": 123,
  "creditsPurchased": 123,
  "totalMonthlyLimit": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

workspaceId
string
required

Response

200 - application/json

Default Response

totalSessions
number
required
webSessions
number
required
whatsappSessions
number
required
aiResponses
number
required
totalCreditsConsumed
number
required
creditsUsedThisMonth
number
required
plan
enum<string>
required
Available options:
HOBBY,
CORE,
SCALE,
LIFETIME,
OFFERED,
CUSTOM,
UNLIMITED,
DEDICATED
creditsRecurring
number
required
creditsPurchased
number
required
totalMonthlyLimit
number
required