tierstring required
Account plan identifier associated with the API key.
api_key_idstring required
customer_idstring required
The account this key belongs to. Stable across key rotation; key per-customer client state on this, not on api_key_id.
key_hintstring nullable
Last 4 characters of the key's plaintext, so the holder can recognize it. null on keys minted before this was recorded.
key_created_atstring nullable
When this key was minted (ISO 8601). null if unknown.
customer_namestring required
quota_limitinteger required
Credit allowance for the current period, not a number of requests.
current_usageinteger required
Credits charged plus credits reserved by requests still in progress. Unused reservations are released on settlement.
remaininginteger required
Credits available to spend, after charges and current holds. Same value as available.
availableinteger nullable
Credits you can spend now; the same value as remaining. Already net of credits frozen by in-flight reservations.
owedinteger nullable
Credits owed after a refunded or disputed top-up took back credits that were already spent. The next top-up covers this first, so it adds this much less to available. 0 for an account in credit.
call_credit_holdinteger nullable
Credits one outbound call freezes at dial time (a refundable hold, not a charge). available // call_credit_hold is the credit-limited bound on calls in flight. Entitlement and the per-customer concurrency cap apply separately, so that many calls are not guaranteed to start.
max_placesinteger nullable
Total places search and import may deliver to this key (self-serve trial cap). Null when the key is uncapped.
places_usedinteger nullable
Places delivered so far, plus those reserved by in-flight requests, against max_places. Null when uncapped.
contact_emailstring nullable
The address a support or sales reply would be sent to: the email on this key. Empty string when the key carries none. Null from a backend that predates the field.
credits_per_fieldinteger nullable
Credits one (place × field) fill costs in deep research.
credits_per_placeinteger nullable
Credits one found/imported place costs (places search + import).
enrichmentobject nullable
Per-lane pricing for POST /v1/enrich: lanes (standard and deep_research, each with credits and unit), mixed, and the deprecated aliases that resolve to the same handler.
open_invoicesobject[] nullable
Open (unpaid) invoices raised for this key, newest first.
percentage_usednumber required
reset_datestring required
When a periodic quota resets. Informational only on a lifetime key.
periodstring required
Quota period. lifetime for self-serve keys: their credits never expire.
statusstring required
API key status (active, revoked, suspended)
validation_timestampstring nullable
UTC timestamp when usage response was produced (ISO 8601).
mcp_confirm_limitinteger
Credits above which the Places MCP connector asks before running a request.
mcp_daily_credit_capinteger
The most an AI assistant may spend from this account per UTC day: the account's own cap, else the default.
mcp_daily_credit_cap_defaultinteger
The default daily cap, so a client can offer a reset to it.
mcp_spent_todayinteger
Credits counted against today's MCP cap, in UTC. A hold counts in full even when the final charge is lower; a request that never ran gives its count back.