Sign in

v

latestOpenAPI 3.1.02026-08-09127104507.8 KB
Subscribe

Get credits balance

Get credits balance.

get/api/v1/credits

Response

Credits balance and usage

auto_topup_amount_dollarsnumber required

Configured dollar amount for each automatic top-up.

auto_topup_enabledboolean required
auto_topup_thresholdstring required

Credit balance threshold that triggers automatic top-up when enabled, represented as a bigint string.

balancestring required

Current credit balance as a bigint string to preserve precision above Number.MAX_SAFE_INTEGER.

lifetime_purchasedstring required

Lifetime purchased credits as a bigint string.

lifetime_usedstring required

Lifetime consumed credits as a bigint string.

Example response

{
  "auto_topup_amount_dollars": 10,
  "auto_topup_threshold": "50000",
  "balance": "50000",
  "lifetime_purchased": "200000",
  "lifetime_used": "150000"
}