Skip to main content
GET
Get account credit usage
No input is required; no credits are consumed. The API key determines the account.
  • plan: current account plan.
  • credits_limit: monthly allowance, excluding purchased top-ups.
  • monthly_credits_remaining: unused credits for the calendar month.
  • topup_credits: purchased balance, not reset at month boundaries.
  • credits_remaining: monthly remaining plus top-ups.
  • period_start, period_end: start of this and next calendar month, UTC.
Read usage before a large full page and after payment confirmation. A balance read does not reserve credits: concurrent requests can spend them before search settlement. After an unconfirmed search charge or lost response, inspect usage before retrying, since retries can incur another debit.

Authorizations

Authorization
string
header
required

Enricho API key (enr_...)

Response

Success envelope.

success
boolean
required
result
object
required
message
string
required