Read the authenticated customer's prepaid balance.

Returns balance, reserved funds, available funds, and active gateway policy without exposing customer tokens.

GET /v1/billing/account

Returns balance, reserved funds, available funds, and active gateway policy without exposing customer tokens.

Authentication

API Key (header: X-B3IQ-Customer-ID) API Key (header: X-B3IQ-Customer-Token)

Responses

200 Customer prepaid account status.

application/json

status string

Enum: ok

customer_id string

display_name string

account_status string

balance_wei string

reserved_wei string

available_wei string

gateway_policy object | null

default B3IQ-native problem response.

curl -X GET 'https://{controlPlaneHost}/v1/billing/account' \  -H 'X-B3IQ-Customer-ID: YOUR_API_KEY'

const response = await fetch('https://{controlPlaneHost}/v1/billing/account', {  method: 'GET',  headers: {      "X-B3IQ-Customer-ID": "YOUR_API_KEY"  }});const data = await response.json();console.log(data);

200 Response

{  "status": "ok",  "customer_id": "<string>",  "display_name": "<string>",  "account_status": "<string>",  "balance_wei": "<string>",  "reserved_wei": "<string>",  "available_wei": "<string>",  "gateway_policy": "<object>"}

default Response

{  "error": {    "status": 123,    "title": "<string>",    "detail": "<string>",    "code": "<string>"  }}

GET /v1/billing/account

Base URL

Response

Was this page helpful?

Previous Read billing state for a private job or paid pooled-sync gateway call.

Next Export the authenticated customer's ledger usage.