Retrieve the balance

GET

/api/v1/balance

Docs menu

Your credits. available is what you can spend, held is already subtracted for checks in progress. A test key gets a note that test mode is not charged.

Key
Bearer key, test or live
Scope
read

Response

200. The balance (live key) or the test-mode note (test key).

Errors

CodeStatusMeaning
missing_scope403The API key does not have the scope this endpoint needs.

Any request can also fail with missing_api_key, invalid_api_key, api_key_revoked, rate_limited or internal_error. See Errors.

In test mode