Usage
Account
Usage
GET /v1/usage
GET
Usage
Reports your key’s plan, current rate limit state, and consumption history. Free.
Because it costs nothing and reports all three rate limit windows at once, this is the right endpoint to poll from a dashboard or to check before starting a large job.
Query parameters
string
default:"month"
Window for the usage figures. One of
day, week, month. Anything else returns INVALID_PARAMETER.Request
Response
object
Notes
plan reports the internal plan name (Developer, Startup), not the tier you bought. See plans.
total_credits exceeding total_requests is expected, not a billing error. A 50-wallet batch is one request and 50 credits.
error_rate is already a percentage. 0.24 means 0.24%, not 24%.
Unlimited plans report the string "unlimited" in plan_limits where a number would otherwise be, so parse defensively.
Errors
INVALID_PARAMETER, plus the standard errors.