Skip to main content
GET
Get a customer's agent balance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customer_id
string
required

Query Parameters

agent
string

Agent scope identifier. Null on scoped results denotes the customer's shared pool.

Required string length: 1 - 128
Example:

"support"

Response

agent
string | null
required

Agent scope identifier. Null on scoped results denotes the customer's shared pool.

Example:

"support"

mode
enum<string> | null
required

Billing mode.

  • wallet: Charges a monetary wallet.
  • credits: Consumes a credit balance.
  • windows: Meters weighted units against rolling allowances.
Available options:
wallet,
credits,
windows
Example:

"wallet"

balance
object
required

Current balance in the accompanying denomination.

Example:
blocked
boolean
required

Whether spending is disabled for this billing scope.

Example:

false

policy
object | null
required

Billing rules resolved for this scope, or null when unconfigured.

Example:

null

meters
object[] | null
required

Current state of every rolling allowance window, or null outside windows mode.

Example:
credits
object | null
required

Credit balance and product details, or null outside credits mode.

Example:

null

overage
object | null
required

Overage policy, current boundary status and unsettled monetary balance; null in wallet mode.

Example:
last_settled_at
string<date-time> | null
required

Last settled at, as a UTC ISO 8601 timestamp. Null when unavailable.

Example:

"2026-09-02T00:00:00Z"

agents
object[]
required

Agent scopes with their own policy or consumption history.

Example: