Credits

Get the credit balance

The account's total credit balance and the credits reserved by extractions in progress. The usable balance is credits_balance minus credits_reserved. Costs nothing, so it is the call to verify a new key with.

Rate limit: 60 requests per minute per API key.

get/credits/balance

Request

  • Base URL: https://api.invoicedataextraction.com/v1
  • URL: https://api.invoicedataextraction.com/v1/credits/balance
  • Auth: HTTP bearer

Response

The balance.

successtrue required
credits_balanceinteger required

Total balance, paid and free credits together.

credits_reservedinteger required

Held by extractions in progress; up to this much is deducted when they complete.

Changes

No recorded changes to this operation across all 1 revision of this API.