管理

組織残高を取得

管理トークンに紐づく組織の現在の残高合計を返します。

GEThttps://api.tokenlab.sh/v1/management/balance

概要

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

注意事項

  • 金額フィールドは USD のみをサポートします。

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

例

リクエスト

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

リクエスト / レスポンス

このページでは OpenAPI スキーマとコピー可能なリクエスト例を提供します。管理リクエストは、Management Token を使ってターミナルまたはクライアントから送信してください。このページから直接送信することはできません。

レスポンス例

レスポンス

200 OK
{
  "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"
}

重要フィールド

objectstring
常に organization_balance です。
organization_idstring
現在の Management token に紐づく組織です。
balancenumber
現在の組織残高です。USD の JSON number で表示向けです。
balance_decimalstring
現在の組織残高です。USD の厳密な decimal string で照合向けです。
total_rechargenumber
組織の成功済みチャージ総額です。USD の JSON number で表示向けです。
total_recharge_decimalstring
組織の成功済みチャージ総額です。USD の厳密な decimal string で照合向けです。
total_usednumber
組織の累計利用額です。USD の JSON number で表示向けです。
total_used_decimalstring
組織の累計利用額です。USD の厳密な decimal string で照合向けです。

認証

ManagementTokenAuth
AuthorizationBearer <token>

管理トークン認証。Dashboard > API > Management Tokensで管理トークンを作成または管理します。

場所: header

レスポンス

application/json

application/json

application/json

application/json