Get Account Metrics (v5.0)

Returns usage metrics for the authenticated account in the legacy core/geo format (the /account/metrics shape without the merchant_* counters).

Authentication

X-API-KEYstring
API Key authentication via header

Query parameters

keystringOptional10-100 characters

API key identifying the account whose usage metrics are returned. May be supplied as this query parameter or the X-API-KEY header.

Response

OK
core_request_countlong

Number of core (tax lookup) requests the account has consumed in the current billing period.

core_request_limitlong
Maximum core requests allowed for the account in the current period, from the account's entitlement.
core_usage_percentdouble

Core request usage as a percentage of the limit (0–100).

geo_enabledboolean

Whether the account has the geocoding (geo_enabled) entitlement that allows address and coordinate lookups.

geo_request_countlong
Number of geocoding requests the account has consumed in the current period.
geo_request_limitlong
Maximum geocoding requests allowed for the account in the current period.
geo_usage_percentdouble

Geocoding request usage as a percentage of the limit (0–100).

is_activeboolean
Whether the account is currently active and able to make requests.
messagestring
Informational message about the account.

Errors

400
Get Account Metrics V50request Bad Request Error
422
Get Account Metrics V50request Unprocessable Entity Error
500
Get Account Metrics V50request Internal Server Error