メインコンテンツへスキップ
POST
チームのクレジット残高を取得

概要

チームの現在のクレジット残高情報を取得します。これには、各シートに割り当てられたプロンプトクレジット、シート数、追加クレジットの使用量、請求サイクルの日付が含まれます。
このエンドポイントには、現在の請求サイクルの情報のみが反映されます。 前のサイクルの過去の使用量は返されません。特に、addOnCreditsAvailable累計総量ではありません。これは、前のサイクルで消費された量に基づいて各請求サイクルの開始時に再計算されるため、表示される値は月ごとに変動します。チームが前のサイクルで追加クレジットを使用した場合、このサイクルの開始時点での addOnCreditsAvailable は、当初購入した量より少なくなります。

リクエスト

service_key
string
必須
「Billing Read」権限を持つサービスキー

リクエスト例

レスポンス

promptCreditsPerSeat
integer
現在の請求サイクルで各シートに割り当てられるプロンプトクレジット数
numSeats
integer
チーム内のシート数
addOnCreditsAvailable
integer
現在の請求サイクルに限りチームで利用可能な追加クレジット数。この値は前のサイクルの使用量に基づいて各請求サイクルの開始時に再計算されるため、月ごとに変動し、購入した追加クレジットの累計総数ではありません。
addOnCreditsUsed
integer
現在の請求サイクルに限りこれまでに消費された追加クレジット数。このカウンターは新しいサイクルの開始時にリセットされ、以前のサイクルの使用量は含まれません。
billingCycleStart
string
現在の請求サイクルの開始日時 (ISO 8601 タイムスタンプ)
billingCycleEnd
string
現在の請求サイクルの終了日時 (ISO 8601 タイムスタンプ)

レスポンス例

エラー応答

よくあるエラーの例:
  • サービスキーが無効、または権限が不足している
  • ご利用中のプランではこの機能を利用できません (Enterprise ティアが必要です)
  • レート制限を超過しました