Skip to main content
GET
/
orgs
/
me
/
usage
cURL
curl --request GET \
  --url https://api.useanima.sh/v1/orgs/me/usage \
  --header 'Authorization: Bearer <token>'
{
  "period": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "totals": {}
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Query Parameters

​
period
string

Billing period in YYYY-MM format (e.g. '2026-05'). Defaults to the current month in UTC.

Response

200 - application/json

OK

Usage rollup for an organization's billing period

​
period
string
required

Billing period the rollup covers (YYYY-MM).

​
updatedAt
string<date-time> | null
required

Latest update timestamp across all returned counters. null if no usage has been recorded yet.

​
totals
object
required

Counters keyed by usage type (e.g. 'email_sent', 'sms_sent', 'voice_call_minutes'). Missing keys mean zero.