Workspace · Usage

Account billing snapshot (plan, cycle, balance, caps, status)

Returns the account billing snapshot (plan, cycle, balance, caps, status).

GEThttps://api.pozy.ai/v1/billing

getBilling

Guides: Billing and payments, Usage and spend

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

Example

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

const res = await fetch("https://api.pozy.ai/v1/billing", {
  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/billing",
    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 metronome, stripe, shopify.
planobject
- namestring
- isUsageBasedboolean
- isPaidboolean
shopifyShopDomainstring
Can be null.
periodobject
- startstring (date-time)
  Can be null.
- endstring (date-time)
  Can be null.
- anchorDayinteger
balanceobject
Can be null.
- accruedThisPeriodCentsinteger
- creditsRemainingCentsinteger
capsobject
- xSpendUsedCentsinteger
- xSpendLimitCentsinteger
  Can be null.
statusobject
7 child fields
- hasAccessboolean
- suspendedboolean
- suspendedAtstring (date-time)
  Can be null.
- suspensionReasonstring
  Can be null.
- openInvoiceUrlstring
  Can be null.
- declineReasonstring
  Can be null.
- autoUpgradeEnabledboolean
legacyobject
- limitsobject
  2 child fields
  - uploadsinteger
  - profilesinteger

200 response

{
  "billingSystem": "metronome",
  "plan": {
    "name": "Acme",
    "isUsageBased": true,
    "isPaid": true
  },
  "shopifyShopDomain": "string",
  "period": {
    "start": "2026-10-02T09:00:00.000Z",
    "end": "2026-10-02T09:00:00.000Z",
    "anchorDay": 1
  },
  "balance": {
    "accruedThisPeriodCents": 1,
    "creditsRemainingCents": 1
  },
  "caps": {
    "xSpendUsedCents": 1,
    "xSpendLimitCents": 1
  },
  "status": {
    "hasAccess": true,
    "suspended": true,
    "suspendedAt": "2026-10-02T09:00:00.000Z",
    "suspensionReason": "string",
    "openInvoiceUrl": "https://pozy.ai/media/example-1.jpg",
    "declineReason": "string",
    "autoUpgradeEnabled": true
  },
  "legacy": {
    "limits": {
      "uploads": 1,
      "profiles": 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

GETGet X API pricing table GETUsage snapshot (default) or billed-spend metering (with params)GETGet plan and usage snapshot (plan, limits, payment status)GETCalling usage and cost GETSMS usage (volumes)