> ## 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.

# 设置用量配置

> 设置或清除每位用户的附加额度上限，并可将其应用到整个团队、组或单个用户，用于 Enterprise 账单管理。

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

为贵组织中的每位用户设置或移除附加积分的使用上限。使用上限始终按用户逐一生效。当你指定团队或群组作为作用范围时，上限会分别应用到该团队或群组中的每个用户，而不会为整个团队或群组设置一个共享总上限。

<div id="request">
  ## 请求
</div>

<ParamField body="service_key" type="string" required>
  具有“Billing Write”（账单写入）权限的服务密钥
</ParamField>

<div id="credit-cap-configuration-choose-one">
  ### 额度上限配置（择一）
</div>

<ParamField body="clear_add_on_credit_cap" type="boolean">
  设为 `true` 以清除现有的附加额度上限
</ParamField>

<ParamField body="set_add_on_credit_cap" type="integer">
  设置新的附加额度上限（整数）
</ParamField>

<Info>
  必须提供 `clear_add_on_credit_cap` 或 `set_add_on_credit_cap` 其中之一，且不可同时提供。
</Info>

<div id="scope-configuration-choose-one">
  ### 作用域配置（任选其一）
</div>

<ParamField body="team_level" type="boolean">
  设为 `true`，将每用户额度上限应用到团队中的每位用户
</ParamField>

<ParamField body="group_id" type="string">
  通过提供组 ID，将每用户额度上限应用到指定组中的每位用户
</ParamField>

<ParamField body="user_email" type="string">
  通过提供其电子邮箱地址，将配置应用到指定用户
</ParamField>

<Info>
  必须提供 `team_level`、`group_id` 或 `user_email` 之一以定义作用域。
</Info>

<div id="example-request-set-per-user-credit-cap-for-all-users-on-team">
  ### 示例请求 - 为团队中所有用户设置个人积分上限
</div>

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

<div id="example-request-set-per-user-credit-cap-for-all-users-in-a-group">
  ### 示例请求：为用户组内所有用户设置个人额度上限
</div>

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

<div id="example-request-set-credit-cap-for-user">
  ### 示例请求 - 设置用户信用额度上限
</div>

```bash theme={null}
curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "set_add_on_credit_cap": 1000,
  "user_email": "user@example.com"
}' \
https://server.codeium.com/api/v1/UsageConfig
```

<div id="example-request-clear-credit-cap">
  ### 示例请求 - 清除额度上限
</div>

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

<div id="response">
  ## 响应
</div>

响应体为空。`200` 状态码表示操作成功。

<div id="error-responses">
  ## 错误响应
</div>

常见错误场景：

* 服务密钥无效或权限不足
* 同时提供了 `clear_add_on_credit_cap` 和 `set_add_on_credit_cap`
* 未提供 `clear_add_on_credit_cap` 或 `set_add_on_credit_cap`
* 提供了多个 scope 参数
* 未提供 scope 参数
* 群组 ID 或用户邮箱无效
* 超出速率限制