API reference / Credit balance

Credit balance

Read your shared website/API balance and free website allowance. Verified accounts receive 30 free credits per calendar month. API requests use monthly free or purchased credits, never the five-per-day website allowance. monthlyFree reports the remaining monthly credits and next renewal as a Unix timestamp.

GET/api/account
Authenticate with X-API-Key. Keep your key on your server; never embed it in a public website.

Response

200 · Success
{
  "credits": 30,
  "monthlyFree": {
    "limit": 30,
    "remaining": 30,
    "renewsAt": 1790812800
  },
  "freeRemaining": 0,
  "freeLimit": 5
}

Errors use a structured error.code and error.message. See error handling →

Clearcut support