Skip to main content

Get plan limits and current usage

GET 

/api/v1/usage

Requires the account:read scope.

Reports what the account's plan allows and how much of it is spent, so a client can tell a quota refusal apart from a bug before it makes the call.

Account-level, not per profile. The plan belongs to the account that owns the token, and the counts cover everything under it. There is no {handle} here for that reason.

The api figures are as of this request, already counted — identical to the RateLimit header on this same response. Polling here costs a request like any other call, so prefer reading that header off the responses you are already making.

A resource with no plan limit reports unlimited: true with limit and remaining both null. api.daily is one of them on every plan: no plan meters total calls, so it is always unlimited, and api.burst is the only figure there worth pacing against.

Request​

Responses​

Plan limits and usage