query · Module: Billing
Arguments
None.Returns
Balance!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query Balance {
balance {
object
account
available {
amount
currency
}
pending {
amount
currency
}
low_balance_threshold {
amount
currency
}
}
}
{}
{
"data": {
"balance": {
"object": "balance",
"account": "acct_ada",
"available": {
"amount": 1299,
"currency": "usd"
},
"pending": {
"amount": 1299,
"currency": "usd"
},
"low_balance_threshold": {
"amount": 1299,
"currency": "usd"
}
}
}
}
Retrieve the prepaid balance
query Balance {
balance {
object
account
available {
amount
currency
}
pending {
amount
currency
}
low_balance_threshold {
amount
currency
}
}
}
{}
{
"data": {
"balance": {
"object": "balance",
"account": "acct_ada",
"available": {
"amount": 1299,
"currency": "usd"
},
"pending": {
"amount": 1299,
"currency": "usd"
},
"low_balance_threshold": {
"amount": 1299,
"currency": "usd"
}
}
}
}
query · Module: Billing
Balance!
| Field | Type |
|---|---|
object | BalanceObject |
account | String |
available | Money |
pending | Money |
low_balance_threshold | Money |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Balance {
balance {
object
account
available {
amount
currency
}
pending {
amount
currency
}
low_balance_threshold {
amount
currency
}
}
}
{}
{
"data": {
"balance": {
"object": "balance",
"account": "acct_ada",
"available": {
"amount": 1299,
"currency": "usd"
},
"pending": {
"amount": 1299,
"currency": "usd"
},
"low_balance_threshold": {
"amount": 1299,
"currency": "usd"
}
}
}
}