Skip to main content
GET
JavaScript

Retrieve credit usage

Get the credits used in the current period, how many are included in your plan, and when usage resets. Paid plans reset with the billing cycle; the free plan uses a rolling 30-day window that starts with your first request. Cost: 0 credits

Authorizations

Authorization
string
header
required

API Key Authentication Provide your API key as a Bearer token in the Authorization header.

Rejected keys return a JSON body {"message": "..."} naming the reason:

  • 401 API key is missing, API key is invalid, API key is disabled or API key has expired
  • 429 API key rate limit exceeded or API key usage limit exceeded

Response

Successful credit usage lookup

used_credits
integer
required
included_credits
integer
required
remaining_credits
integer
required

Never negative; zero once usage exceeds included credits.

overage_credits
integer
required

Credits above the included allowance.

paid
boolean
required
period
object
required