Pular para o conteúdo principal
POST
/
api
/
v1
/
GetTeamCreditBalance
Obter saldo de créditos da equipe
curl --request POST \
  --url https://server.codeium.com/api/v1/GetTeamCreditBalance \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>"
}
'
{
  "promptCreditsPerSeat": 123,
  "numSeats": 123,
  "addOnCreditsAvailable": 123,
  "addOnCreditsUsed": 123,
  "billingCycleStart": "<string>",
  "billingCycleEnd": "<string>"
}

​
Visão geral

Obtenha as informações sobre o saldo atual 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 cobrança.

​
Requisição

​
service_key
string
obrigatório
Sua Service Key com permissões “Cobrança 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

​
Response

​
promptCreditsPerSeat
integer
Número de créditos de prompt alocados por licença para o ciclo de cobrança atual
​
numSeats
integer
Número de licenças na equipe
​
addOnCreditsAvailable
integer
Total de créditos complementares disponíveis para a equipe
​
addOnCreditsUsed
integer
Créditos complementares consumidos até agora no ciclo de cobrança atual
​
billingCycleStart
string
Início do ciclo de cobrança atual (carimbo de data/hora no formato ISO 8601)
​
billingCycleEnd
string
Fim do ciclo de cobrança atual (carimbo de data/hora no formato 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 não disponível para o seu plano (requer o plano Enterprise)
  • Limite de requisições excedido