Credits
Check balance, read the ledger, browse credit packs, and mint a checkout URL.
Credits are the billing unit of the Console API. Balance lookups are cheap and safe to poll before triggering work; the ledger gives you the full audit trail of purchases, consumption, and refunds with both JSON and CSV formats. When balance runs low, list the available packs and mint a Freemius checkout URL to top up.
Credit costs per platform and per add-on are documented under Credit model. Preview a scan's cost before submitting it via POST /scans/preview under Scans.
GET
/
credits/balanceHeader Parameters
X-API-KeyX-Api-Key
Successful Response
GET
/
credits/ledgerSuccessful Response
GET
/
credits/ledger.csvHeader Parameters
X-API-KeyX-Api-Key
Successful Response
GET
/
credits/packsHeader Parameters
X-API-KeyX-Api-Key
Successful Response
POST
/
credits/checkoutSuccessful Response