管理

ワークスペース残高の取得

現在のワークスペースの残高、チャージ合計、および利用料金を取得します。

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

概要

管理トークンに関連付けられたワークスペースの残高、チャージ合計、および利用料金の合計を返します。

注意事項

  • 金額フィールドはUSDのみです。

  • 金額はUSDで返されます。正確な計算を行うには、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スキーマとコピー可能なリクエスト例を提供しています。管理リクエストは、ターミナルまたはクライアントから管理トークンを使用して送信してください。このページから直接送信することはできません。

レスポンス例

レスポンス

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
現在の管理トークンに関連付けられた組織ID。
balancenumber
表示用のJSON数値としての、現在の組織のUSD残高。
balance_decimalstring
照合用の10進数文字列としての、正確な現在の組織のUSD残高。
total_rechargenumber
表示用のJSON数値としての、組織のチャージ合計額(USD)。
total_recharge_decimalstring
照合用の10進数文字列としての、正確な組織のチャージ合計額(USD)。
total_usednumber
表示用のJSON数値としての、組織の利用料金合計(USD)。
total_used_decimalstring
照合用の10進数文字列としての、正確な組織の利用料金合計(USD)。

認証

ManagementTokenAuth
AuthorizationBearer <token>

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

場所: header

レスポンス

application/json

application/json

application/json

application/json