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

# Consultar saldo de créditos da equipe

> Recupera o saldo atual de créditos da sua equipe, incluindo créditos de prompt por assento, créditos adicionais e informações sobre o ciclo de faturamento.

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

Recupera as informações atuais do saldo de créditos da sua equipe. Isso inclui os créditos de prompt alocados por assento, o número de assentos, o uso de créditos adicionais e as datas do ciclo de faturamento.

<Warning>
  **Este endpoint reflete apenas o ciclo de faturamento atual.** Ele não retorna o uso histórico de ciclos anteriores.

  Em particular, `addOnCreditsAvailable` **não** é um total vitalício — ele é recalculado no início de cada ciclo de faturamento com base no que foi consumido no ciclo anterior, portanto o valor exibido mudará de um mês para outro. Se sua equipe usou créditos adicionais no último ciclo, `addOnCreditsAvailable` no início deste ciclo será menor do que a quantidade originalmente comprada.
</Warning>

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

<ParamField body="service_key" type="string" required>
  Sua chave de serviço com a permissão "Billing Read"
</ParamField>

<div id="example-request">
  ### Exemplo de requisição
</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">
  ## Resposta
</div>

<ResponseField name="promptCreditsPerSeat" type="integer">
  Número de créditos de prompt alocados por assento no ciclo de faturamento atual
</ResponseField>

<ResponseField name="numSeats" type="integer">
  Número de assentos na equipe
</ResponseField>

<ResponseField name="addOnCreditsAvailable" type="integer">
  Créditos adicionais disponíveis para a equipe **apenas no ciclo de faturamento atual**. Esse valor é recalculado no início de cada ciclo de faturamento com base no uso do ciclo anterior, portanto varia de um mês para outro e não representa o total vitalício de créditos adicionais comprados.
</ResponseField>

<ResponseField name="addOnCreditsUsed" type="integer">
  Créditos adicionais consumidos até o momento **apenas no ciclo de faturamento atual**. Esse contador é redefinido no início de cada novo ciclo e não inclui o uso de ciclos anteriores.
</ResponseField>

<ResponseField name="billingCycleStart" type="string">
  Início do ciclo de faturamento atual (timestamp ISO 8601)
</ResponseField>

<ResponseField name="billingCycleEnd" type="string">
  Fim do ciclo de faturamento atual (timestamp ISO 8601)
</ResponseField>

<div id="example-response">
  ### Exemplo de resposta
</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">
  ## Respostas de erro
</div>

Cenários comuns de erro:

* Chave de serviço inválida ou permissões insuficientes
* Recurso indisponível no seu plano (requer nível Enterprise)
* Limite de requisições excedido