Returns your workspace's validation credit balance in real time — remaining, used, and granted credits per allowance type.
Free to call: this endpoint never consumes credits. Credits are shared across the API, CSV uploads, and in-app validations, so the figures reflect your workspace's total consumption, not just API usage.
Every key is always present in the response; null means the field does not apply to your plan. Unlimited plans report usage only — limit, remaining, and creditsRemaining are null.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Returns your workspace's validation credit balance in real time — remaining, used, and granted credits per allowance type, read from the same store that meters every validation.
Worth knowing before you build:
- Free to call. This endpoint never consumes credits, and it counts against your normal per-key rate limit only.
- Real time. The numbers move the moment a validation is charged; a validation racing your read may shift them by a few seconds.
- Workspace-wide. Credits are shared across the API, CSV uploads, and in-app validations —
usedis your workspace's total consumption, not just this API key's. - Every key is always present.
nullmeans "not applicable to your plan", never "unknown". - Additional credits spend first. If you have both
additionalCreditsand amonthlyAllowance, the additional balance is drawn down before the monthly one.
planType determines which blocks are populated:
monthly—monthlyAllowancecarries your plan's allowance, resetting on the 1st of each calendar month (UTC, seeresetsOn).unlimited— unlimited plans report usage only:limit,remaining, andcreditsRemainingarenull, andmonthlyAllowance.usedtracks the current month. (Unlimited email verification has no credit limits via integration or CSV; API access is capped at 1,000,000 requests per month — see our plans page.)prepaid— your workspace runs on additional credits alone;additionalCredits.grantedis the total ever granted, and nothing resets.none— no credits are provisioned; validation calls will return 402 until credits are added.
For alerting, watch creditsRemaining — it's the single number that predicts when validation calls start returning 402. See the Credits overview for how the allowance types fit together.