メインコンテンツへスキップ

​
概要

このエンドポイントは、管理トークンに紐づく組織の現在の残高合計を返します。請求と決済で使う組織残高の同じ信頼できる情報源を参照します。

​
注意事項

  • 金額フィールドは USD で返されます。表示には balance、total_recharge、total_used を使い、厳密な請求照合には balance_decimal、total_recharge_decimal、total_used_decimal を使ってください。

​
例

curl -X GET "https://api.tokenlab.sh/v1/management/balance" \
  -H "Authorization: Bearer mt-your-management-token"

​
リクエスト / レスポンス

正確なスキーマについては、上記のインタラクティブな OpenAPI パネルを使用してください。

​
レスポンス例

{
  "object": "organization_balance",
  "organization_id": "org_123",
  "balance": 42.5,
  "balance_decimal": "42.50",
  "total_recharge": 100,
  "total_recharge_decimal": "100",
  "total_used": 57.5,
  "total_used_decimal": "57.50"
}

​
重要フィールド

​
object
string
常に organization_balance です。
​
organization_id
string
現在の Management token に紐づく組織です。
​
balance
number
現在の組織残高です。USD の JSON number で表示向けです。
​
balance_decimal
string
現在の組織残高です。USD の厳密な decimal string で照合向けです。
​
total_recharge
number
組織の成功済みチャージ総額です。USD の JSON number で表示向けです。
​
total_recharge_decimal
string
組織の成功済みチャージ総額です。USD の厳密な decimal string で照合向けです。
​
total_used
number
組織の累計利用額です。USD の JSON number で表示向けです。
​
total_used_decimal
string
組織の累計利用額です。USD の厳密な decimal string で照合向けです。