查詢帳戶餘額
讀取帳戶餘額或子帳戶預算
中國大陸用戶請注意: 中國大陸用戶請使用 https://api.toapis.cn 作為接口地址 (Base URL). 文檔示例中的 https://api.toapis.com 請替換為 https://api.toapis.cn.
驗證, 分頁及錯誤處理請參閱接入方式.
使用說明
回傳當前帳戶的餘額資訊, 用於查看剩餘可用額度. balance_kind 區分餘額類型: account_balance 為帳戶餘額, subaccount_budget 為子帳號自身預算 (不含父帳號金額). remaining_* 和 used_* 欄位來自同一額度快照, USD 金額按回應中的 credits_per_usd 換算.
驗證
Authorizationstring請求頭必填使用系統存取權杖, 格式為 Bearer YOUR_SYSTEM_ACCESS_TOKEN. 此介面不接受模型 API Key, 不需要 X-User-Id.
請求參數
此介面不接受路徑或查詢參數, 不需要請求主體.
請求範例
請求示例
curl --request GET \
--url 'https://api.toapis.com/api/v1/account/balance' \
--header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'import requests
response = requests.get(
"https://api.toapis.com/api/v1/account/balance",
headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
timeout=30,
)
response.raise_for_status()
print(response.json())const url = new URL("https://api.toapis.com/api/v1/account/balance");
const response = await fetch(url, {
headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());回應欄位
範例使用虛構資料, 並假設 credits_per_usd="100". 實際換算請以回應為準.
codeinteger業務狀態碼, 成功時為 0.
messagestring回應訊息, 成功時為空字串. 錯誤訊息依請求語言回傳.
dataobject本次查詢的結果物件.
data.remaining_creditsstring剩餘額度, 單位為 credits. 以十進位字串回傳以保留精度.
data.used_creditsstring已用額度, 單位為 credits. 以十進位字串回傳以保留精度.
data.remaining_usdstring剩餘額度換算的 USD 金額. 以十進位字串回傳以保留精度.
data.used_usdstring已用額度換算的 USD 金額. 以十進位字串回傳以保留精度.
data.credits_per_usdstring每 1 USD 對應的 credits 數量. 請以此值換算. 以十進位字串回傳以保留精度.
data.balance_kindstringaccount_balance 為帳戶餘額, subaccount_budget 為子帳戶自身預算, 不含父帳戶餘額.
回應範例
響應示例
{
"code": 0,
"message": "",
"data": {
"remaining_credits": "1000",
"remaining_usd": "10",
"used_credits": "100",
"used_usd": "1",
"credits_per_usd": "100",
"balance_kind": "account_balance"
}
}