Skip to main content
GET
Get Usage

Overview

Returns API usage for the current billing period, broken down by metered endpoint type, plus the per-endpoint-type requests-per-minute limits your plan enforces. by_endpoint_type reports used and limit for each metered endpoint type: search, read, screening, and check. A limit of null means unlimited on your plan; 0 means the endpoint type is not available on your plan. Requires the billing:read scope.

Response

object
string
Always usage.
billing_period
object
by_endpoint_type
object
rate_limits
object
Requests-per-minute limit per endpoint type (search, read, screening, monitoring, utility, reference, check), as enforced by the rate limiter. See Rate Limits for how limits are applied.
request_id
string
Unique request identifier for support and debugging.

Code Examples

Errors