Workspace · Usage

Get plan and usage snapshot (plan, limits, payment status)

Fetches plan and usage snapshot (plan, limits, payment status).

GEThttps://api.pozy.ai/v1/usage-stats

DeprecatedgetUsageStats

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the billing resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

Name	Type	Notes
`reconcile`	boolean

Example

curl -X GET "https://api.pozy.ai/v1/usage-stats" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/usage-stats", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/usage-stats",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

billingSystemstring
One of stripe, metronome.
planNamestring
billingPeriodstring
One of monthly, yearly.
signupDatestring (date-time)
billingAnchorDayinteger
hasAccessboolean
customerIdstring
Can be null.
isInvitedUserboolean
autoUpgradeEnabledboolean
limitsobject
- uploadsinteger
- profilesinteger
usageobject
- uploadsinteger
- profilesinteger
- lastResetstring (date-time)
- connectedAccountsinteger
- xApiCallsobjectdeprecated
  3 child fields
  - x_api_005integer
  - x_api_010integer
  - x_api_015integer
- xApiCallsByOperationmap of integer
spendobject
- currentPeriodCentsinteger
- creditsRemainingCentsinteger
- xSpendCentsinteger
- xSpendLimitCentsinteger
  Can be null.

200 response

{
  "billingSystem": "stripe",
  "planName": "Acme",
  "billingPeriod": "monthly",
  "signupDate": "2026-10-02T09:00:00.000Z",
  "billingAnchorDay": 1,
  "hasAccess": true,
  "customerId": "691909ff82eb5ed7c816716d",
  "isInvitedUser": true,
  "autoUpgradeEnabled": true,
  "limits": {
    "uploads": 1,
    "profiles": 1
  },
  "usage": {
    "uploads": 1,
    "profiles": 1,
    "lastReset": "2026-10-02T09:00:00.000Z",
    "connectedAccounts": 42,
    "xApiCalls": {
      "x_api_005": 1,
      "x_api_010": 1,
      "x_api_015": 1
    },
    "xApiCallsByOperation": {
      "key": 1
    }
  },
  "spend": {
    "currentPeriodCents": 1,
    "creditsRemainingCents": 1,
    "xSpendCents": 1,
    "xSpendLimitCents": 1
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Usage

GETAccount billing snapshot (plan, cycle, balance, caps, status)GETGet X API pricing table GETUsage snapshot (default) or billed-spend metering (with params)GETCalling usage and cost GETSMS usage (volumes)