Get Account Metrics

Returns usage metrics for the authenticated account

X-API-KEYstring

API Key authentication via header

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.

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.

merchant_request_countlong

Number of merchant requests the account has consumed in the current period.

merchant_request_limitlong

Maximum merchant requests allowed for the account in the current period.

merchant_usage_percentdouble

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

messagestring

Informational message about the account.

401

Get Account Metrics Request Unauthorized Error

422

Get Account Metrics Request Unprocessable Entity Error

500

Get Account Metrics Request Internal Server Error