SurfacedBySurfacedBy Docs
DocumentationConsoleReference

Credits

Check balance, read the ledger, browse credit packs, and mint a checkout URL.

Ask an AI:Open in ChatGPTOpen in Claude

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/balance
/credits/balance

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/credits/balance" \
  -H "X-API-Key: string"

Successful Response

null

GET
/credits/ledger
/credits/ledger

Query Parameters

cursorCursor

reasonReason

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/credits/ledger?cursor=0&reason=string" \
  -H "X-API-Key: string"

Successful Response

null

GET
/credits/ledger.csv
/credits/ledger.csv

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/credits/ledger.csv" \
  -H "X-API-Key: string"

Successful Response

null

GET
/credits/packs
/credits/packs

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/credits/packs" \
  -H "X-API-Key: string"

Successful Response

null

POST
/credits/checkout
/credits/checkout

Request Body

application/jsonRequired

[key: string]any

Header Parameters

X-API-KeyX-Api-Key

curl -X POST "https://example.com/credits/checkout" \
  -H "X-API-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

Successful Response

null