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

# Obter configuração de uso

> Obter configuração do limite de uso para créditos adicionais por usuário, consultada por escopo de equipe, grupo ou usuário individual, para gerenciamento de cobrança no plano Enterprise.

<div id="overview">
  ## Visão geral
</div>

Obtenha a configuração atual do limite de créditos de add-on por usuário da sua organização. Os limites são sempre por usuário. Quando você consulta no escopo de equipe ou grupo, a resposta retorna o limite por usuário que foi aplicado aos usuários dentro dessa equipe ou grupo.

<div id="request">
  ## Requisição
</div>

<ParamField body="service_key" type="string" required>
  Sua Service Key com permissões "Cobrança Read"
</ParamField>

<div id="scope-configuration-choose-one">
  ### Configuração de Escopo (Escolha uma)
</div>

<ParamField body="team_level" type="boolean">
  Defina como `true` para recuperar o limite por usuário aplicado a todos os usuários da equipe
</ParamField>

<ParamField body="group_id" type="string">
  Recupere o limite por usuário aplicado a todos os usuários de um grupo específico fornecendo o ID do grupo
</ParamField>

<ParamField body="user_email" type="string">
  Recupere a configuração de um usuário específico fornecendo o endereço de e-mail dele
</ParamField>

<Info>
  Você deve fornecer um de `team_level`, `group_id` ou `user_email` para definir o escopo.
</Info>

<div id="example-request-get-per-user-cap-for-all-users-on-team">
  ### Exemplo de requisição - Obter limite individual para todos os usuários da equipe
</div>

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

<div id="example-request-get-per-user-cap-for-all-users-in-a-group">
  ### Exemplo de requisição - Obter limite individual para todos os usuários de um grupo
</div>

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

<div id="example-request-get-user-configuration">
  ### Exemplo de requisição - Obter configuração do usuário
</div>

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

<div id="response">
  ## Resposta
</div>

<ResponseField name="addOnCreditCap" type="integer">
  O valor configurado do limite de créditos do add-on. Se este campo não estiver presente na resposta, não há limite configurado no nível de escopo solicitado.
</ResponseField>

<div id="example-response-with-cap-configured">
  ### Exemplo de resposta – com limite configurado
</div>

```json theme={null}
{
  "addOnCreditCap": 10000
}
```

<div id="example-response-no-cap-configured">
  ### Resposta de exemplo – nenhum limite configurado
</div>

```json theme={null}
{}
```

<div id="error-responses">
  ## Respostas de erro
</div>

Cenários de erro comuns:

* Chave de serviço inválida ou permissões insuficientes
* Vários parâmetros de escopo fornecidos
* Nenhum parâmetro de escopo fornecido
* ID de grupo ou e-mail de usuário inválidos
* Limite de requisições excedido