CreditsUsage stats

Usage stats

Compact summary of your current period's credit usage — same shape as the status object on /v1/credits.

curl https://api.chuger.com/v1/credits/usage-stats \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "balance": 18675,
  "formatted_balance": "18,675",
  "limit": 20000,
  "used": 1325,
  "is_low": false,
  "threshold": 4000,
  "percentage_used": 6.63,
  "next_renewal": null
}

Returns the same status object embedded in GET /v1/credits, but at the top level. Useful when you only want the summary and don't need the full balance envelope.

GET https://api.chuger.com/v1/credits/usage-stats

All /v1/credits/* endpoints are free to call and not subject to per-minute rate limits.

Authentication

Bearer token in the Authorization header. See Authentication.

Example

Response fields

balanceinteger
Required

Credits remaining this period.

formatted_balancestring
Required

Locale-formatted balance for display purposes.

limitinteger
Required

Total credits in your monthly allowance.

usedinteger
Required

Credits consumed so far this period.

is_lowboolean
Required

true when balance falls below the warning threshold (20% of the limit, with a floor of 50).

thresholdinteger
Required

Low-credit warning threshold.

percentage_usednumber
Required

Usage as a percentage (0–100).

next_renewalstring

ISO-8601 timestamp of the next monthly reset, or null if not yet known.

Errors

StatusWhen
401Missing or invalid token
404The account associated with the token wasn't found

See Errors for the full reference.