Skip to content

Usage

Fields

Nested fields are written with dots; [] marks the items of an array.

FieldTypeAlways presentDescription
as_ofdate-time (RFC 3339, UTC)yes—
enforcementobjectyesThe mode of each limit. off: not used. observe: counted, never refused. enforce: refused when over the limit.
keyobjectyesIts fields follow, as key.….
key.bytesinteger | nullno—
key.fingerprintstringnoThe first 12 hex digits of the key's SHA-256 hash.
key.requestsinteger | nullno—
limitsobject | nullyesYour limits. Null when no limits apply, and for a key without an organization.
limits.burstinteger | nullno—
limits.exemptobject | nullnoYour exemption from the rate limit, or null. When concurrency is true, you are also exempt from the limit on requests at once. The transfer allowance still applies.
limits.exempt.concurrencybooleanno—
limits.exempt.expires_atdate-time (RFC 3339, UTC) | nullnoWhen the exemption ends. Null when no end is set.
limits.exempt.ratebooleanno—
limits.exempt.scopestringnoWho is exempt. key: this key. org: every credential of the organization. config: set in the server's configuration. One of: key, org, config.
limits.monthly_bytesinteger | nullnoResponse bytes included per month, counted before compression. Null means no limit.
limits.monthly_requestsinteger | nullno—
limits.requests_per_secondinteger | nullnoRequests allowed per second. Null when you are exempt from the rate limit.
monthstringyesThe month counted, YYYY-MM, in New York time.
orgobjectyesThis month's usage by all keys of your organization (for an older key without one, by that key). Members are null while usage is not counted.
org.bytesinteger | nullnoBillable response bytes. 5xx and 429 responses are not billed.
org.bytes_remaininginteger | nullno—
org.requestsinteger | nullno—
org_idinteger | nullyesYour organization's ID. Null for an older key that belongs to no organization.
planstring | nullyesYour organization's plan ID. Null when the plan cannot be read; default limits then apply.
reset_atdate-time (RFC 3339, UTC)yesWhen the monthly allowance starts again: midnight New York time at the start of next month (04:00 or 05:00 UTC).

Used by

Markdown version: /docs/reference/schemas/usage.md