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

# 获取团队额度余额

> 获取您的团队当前的额度余额，包括每个席位的提示额度、附加额度，以及账单周期信息。

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

获取您团队当前的额度余额信息。其中包括每个席位分配的提示额度、席位数量、附加额度的使用情况，以及账单周期的起止日期。

<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 套餐）
* 超出调用频率限制