> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devin.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# チームのクレジット残高を取得

> シートごとのプロンプトクレジット、追加クレジット、請求サイクル情報を含む、チームの現在のクレジット残高を取得します。

<div id="overview">
  ## 概要
</div>

チームの現在のクレジット残高情報を取得します。これには、各シートに割り当てられたプロンプトクレジット、シート数、追加クレジットの使用量、請求サイクルの日付が含まれます。

<Warning>
  **このエンドポイントには、現在の請求サイクルの情報のみが反映されます。** 前のサイクルの過去の使用量は返されません。

  特に、`addOnCreditsAvailable` は**累計総量**ではありません。これは、前のサイクルで消費された量に基づいて各請求サイクルの開始時に再計算されるため、表示される値は月ごとに変動します。チームが前のサイクルで追加クレジットを使用した場合、このサイクルの開始時点での `addOnCreditsAvailable` は、当初購入した量より少なくなります。
</Warning>

<div id="request">
  ## リクエスト
</div>

<ParamField body="service_key" type="string" required>
  「Billing Read」権限を持つサービスキー
</ParamField>

<div id="example-request">
  ### リクエスト例
</div>

```bash theme={null}
curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here"
}' \
https://server.codeium.com/api/v1/GetTeamCreditBalance
```

<div id="response">
  ## レスポンス
</div>

<ResponseField name="promptCreditsPerSeat" type="integer">
  現在の請求サイクルで各シートに割り当てられるプロンプトクレジット数
</ResponseField>

<ResponseField name="numSeats" type="integer">
  チーム内のシート数
</ResponseField>

<ResponseField name="addOnCreditsAvailable" type="integer">
  **現在の請求サイクルに限り**チームで利用可能な追加クレジット数。この値は前のサイクルの使用量に基づいて各請求サイクルの開始時に再計算されるため、月ごとに変動し、購入した追加クレジットの累計総数ではありません。
</ResponseField>

<ResponseField name="addOnCreditsUsed" type="integer">
  **現在の請求サイクルに限り**これまでに消費された追加クレジット数。このカウンターは新しいサイクルの開始時にリセットされ、以前のサイクルの使用量は含まれません。
</ResponseField>

<ResponseField name="billingCycleStart" type="string">
  現在の請求サイクルの開始日時 (ISO 8601 タイムスタンプ)
</ResponseField>

<ResponseField name="billingCycleEnd" type="string">
  現在の請求サイクルの終了日時 (ISO 8601 タイムスタンプ)
</ResponseField>

<div id="example-response">
  ### レスポンス例
</div>

```json theme={null}
{
  "promptCreditsPerSeat": 500,
  "numSeats": 50,
  "addOnCreditsAvailable": 10000,
  "addOnCreditsUsed": 3500,
  "billingCycleStart": "2026-01-01T00:00:00Z",
  "billingCycleEnd": "2026-02-01T00:00:00Z"
}
```

<div id="error-responses">
  ## エラー応答
</div>

よくあるエラーの例:

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