Billing

BUZZ exposes two OpenAI-style dashboard billing endpoints so existing tooling (the OpenAI /dashboard/billing/* probes used by many balance-checker scripts and proxy UIs) works out of the box. They report balance and usage in whatever currency unit the site is configured to display.

Authentication

Both endpoints require a user API token (an sk--prefixed key created from the BUZZ console). They run through the relay token-auth chain, the same one used by /v1/messages and /v1/chat/completions.

No Buzz-User header required — the token already encodes the owner.

QuotaDisplayType: how numbers are calculated

BUZZ stores everything as raw integer "quota units" internally and converts to a human-friendly number only when serving these endpoints. The conversion depends on the site's QuotaDisplayType operation setting:

This means soft_limit_usd in the subscription response and total_usage in the usage response are not always USD. The field name is preserved for OpenAI compatibility, but the actual unit follows the site's display-type setting. Treat the unit as opaque and align it with whatever currency your site shows in the dashboard UI.

GET /v1/dashboard/billing/subscription

Returns the token's (or, when token-level stats are disabled, the user's) remaining-plus-used quota, formatted as if it were a "credit limit". This is what most balance-checker tools poll.

Source of numbers

• If the site has token-level stats enabled: quota = token.RemainQuota + token.UsedQuota, access_until = token.ExpiredTime.
• Otherwise: quota = user.Quota + user.UsedQuota, access_until = 0.
• If the token is unlimited, the response value is overridden to 100000000.
• If the token has no expiry, access_until is forced to 0.

Example request

curl -s 'https://buzzai.cc/v1/dashboard/billing/subscription' \
  -H "Authorization: Bearer sk-$BUZZ_TOKEN"

import os, requests

resp = requests.get(
    "https://buzzai.cc/v1/dashboard/billing/subscription",
    headers={"Authorization": f"Bearer sk-{os.environ['BUZZ_TOKEN']}"},
    timeout=10,
)
data = resp.json()
print(data["soft_limit_usd"], data["access_until"])

const resp = await fetch(
  "https://buzzai.cc/v1/dashboard/billing/subscription",
  { headers: { Authorization: `Bearer sk-${process.env.BUZZ_TOKEN}` } },
);
const data = await resp.json();
console.log(data.soft_limit_usd, data.access_until);

Live response

{
  "object": "billing_subscription",
  "has_payment_method": true,
  "soft_limit_usd": 1234.622754,
  "hard_limit_usd": 1234.622754,
  "system_hard_limit_usd": 1234.622754,
  "access_until": 0
}

Verified live on 2026-05-26 with a regular limited-quota token. The three limit fields share a single value; access_until = 0 matches a no-expiry token.

Response fields

GET /v1/dashboard/billing/usage

Returns lifetime consumed quota for the calling token (or user). OpenAI's original endpoint is per-period; this BUZZ implementation returns a single cumulative number and ignores any date-range query parameters.

Source of numbers

• If the site has token-level stats enabled: quota = token.UsedQuota.
• Otherwise: quota = GetUserUsedQuota(userId).
• The same QuotaDisplayType conversion is applied to produce amount.
• Final result is multiplied by 100: total_usage = amount * 100. The codebase comment calls this "unit: 0.01 dollar" — i.e. cents when display is USD. With CNY display the field is cents-of-CNY * exchange rate; with Tokens display it is tokens * 100.

Example request

curl -s 'https://buzzai.cc/v1/dashboard/billing/usage' \
  -H "Authorization: Bearer sk-$BUZZ_TOKEN"

import os, requests

resp = requests.get(
    "https://buzzai.cc/v1/dashboard/billing/usage",
    headers={"Authorization": f"Bearer sk-{os.environ['BUZZ_TOKEN']}"},
    timeout=10,
)
total_cents = resp.json()["total_usage"]
print(f"used: {total_cents / 100:.2f}")  # divide by 100 to recover the display unit

const resp = await fetch(
  "https://buzzai.cc/v1/dashboard/billing/usage",
  { headers: { Authorization: `Bearer sk-${process.env.BUZZ_TOKEN}` } },
);
const { total_usage } = await resp.json();
console.log(`used: ${(total_usage / 100).toFixed(2)}`);

Live response

{
  "object": "list",
  "total_usage": 117621.9826
}

Verified live on 2026-05-26. The number is "display-unit × 100" — divide by 100 to get the value you see in the dashboard.

Response fields

Errors

See also

• GET /api/user/self — for the raw quota integer plus group / affiliate metadata
• GET /api/token/ — manage sk- tokens
• Authentication guide