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.

POST /api/v1/GetTeamCreditBalance

Consultar saldo de créditos da equipe

cURL

curl --request POST \
  --url https://server.codeium.com/api/v1/GetTeamCreditBalance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>"
}
'

200

{
  "promptCreditsPerSeat": 123,
  "numSeats": 123,
  "addOnCreditsAvailable": 123,
  "addOnCreditsUsed": 123,
  "billingCycleStart": "<string>",
  "billingCycleEnd": "<string>"
}

​

Visão geral

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.

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.

​

Requisição

service_key · string · obrigatório

Sua chave de serviço com a permissão “Billing Read”

​

Exemplo de requisição

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

​

Resposta

promptCreditsPerSeat · integer

Número de créditos de prompt alocados por assento no ciclo de faturamento atual

numSeats · integer

Número de assentos na equipe

addOnCreditsAvailable · 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.

addOnCreditsUsed · 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.

billingCycleStart · string

Início do ciclo de faturamento atual (timestamp ISO 8601)

billingCycleEnd · string

Fim do ciclo de faturamento atual (timestamp ISO 8601)

​

Exemplo de resposta

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

​

Respostas de erro

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