Usage

Minutes and usage.

GET/v1/usage

Usage & billing for the current period

getUsageusage:readread: 600/min per key

Session time for the current calendar month (UTC) or the from/to range, with the plan and the minutes the account holds. An unlimited account has no minute counts (null).

Query parameters

fromstring
Start of the period (ISO date or date-time). Default: the start of this calendar month (UTC).
tostring
End of the period (exclusive). Default: the start of next month (UTC).

Returns

200 Usage for the period. data is Usage.

Fields of data

planobjectrequired
- keystringrequired
  free, starter, plus, pro, business or enterprise.
- namestringrequired
- intervalstringrequired
  month or year.
unlimitedbooleanrequired
An unlimited account has no minute counts (the minute fields are null).
includedMinutesinteger | nullrequired
The plan's minutes this cycle.
minutesUsednumberrequired
Session time in the period, in minutes.
remainingMinutesinteger | nullrequired
Every minute the account can still spend: plan, minute packs and bonus.
cycleobjectrequired
- startstring (date-time)required
  ISO 8601 UTC timestamp.
- endstring (date-time)required
  ISO 8601 UTC timestamp.
minutesobject | nullrequired
- planIncludedintegerrequired
- planUsedintegerrequired
- planLeftintegerrequired
- purchasedLeftintegerrequired
  Minute packs; they never expire.
- bonusLeftintegerrequired
- totalLeftintegerrequired
periodobjectrequired
- startstring (date-time)required
  ISO 8601 UTC timestamp.
- endstring (date-time)required
  ISO 8601 UTC timestamp.
sessionCountintegerrequired
bySourceobjectrequired
- portalnumberrequired
- apinumberrequired
byDayobject[]required
- datestringrequired
  YYYY-MM-DD (UTC).
- minutesnumberrequired
- sessionsintegerrequired
byPersonaobject[]required
- personaIdstringrequired
  Persona id (pa_…).
  pattern `^pa_.*`
- personaNamestringrequired
- minutesnumberrequired
- sessionsintegerrequired

Errors

invalid_request unauthorized forbidden upgrade_required rate_limited server_error

Request

curl "https://app.zentiqai.com/v1/usage" \
  -H "Authorization: Bearer $ZENTIQ_API_KEY"

import { Zentiq } from "@zentiq/node";

const zentiq = new Zentiq({ apiKey: process.env.ZENTIQ_API_KEY });
const result = await zentiq.getUsage();

import os
from zentiq import Zentiq

zentiq = Zentiq(api_key=os.environ["ZENTIQ_API_KEY"])
result = zentiq.get_usage()

Example answer

Response

{
  "data": {
    "plan": {
      "key": "pro",
      "name": "Zoe",
      "interval": "month"
    },
    "unlimited": true,
    "includedMinutes": 1,
    "minutesUsed": 1,
    "remainingMinutes": 1,
    "cycle": {
      "start": "2026-09-25T12:00:00.000Z",
      "end": "2026-09-25T12:00:00.000Z"
    }
  },
  "error": null,
  "requestId": "req_4f1c2e9a7b3d5e6f7a8b9c0d"
}