List a customer's balances
One balance per unit the customer holds: a credit type for prepaid plans, a currency for postpaid plans. The same formula applies to both: available = posted - held + limit. Pass as_of to read a past balance.
Authentication
AuthorizationBearer
A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.
Path parameters
customer_id
The customer ID (cus_...).
Query parameters
as_of
Read the balances as they stood at this time. Defaults to now.
Response
The customer's balances.
object
data
has_more
next_cursor
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error