Consultar saldo de créditos da equipe
curl --request POST \
--url https://server.codeium.com/api/v1/GetTeamCreditBalance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"service_key": "<string>"
}
'import requests
url = "https://server.codeium.com/api/v1/GetTeamCreditBalance"
payload = { "service_key": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({service_key: '<string>'})
};
fetch('https://server.codeium.com/api/v1/GetTeamCreditBalance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://server.codeium.com/api/v1/GetTeamCreditBalance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://server.codeium.com/api/v1/GetTeamCreditBalance"
payload := strings.NewReader("{\n \"service_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://server.codeium.com/api/v1/GetTeamCreditBalance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"service_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.codeium.com/api/v1/GetTeamCreditBalance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"service_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"promptCreditsPerSeat": 123,
"numSeats": 123,
"addOnCreditsAvailable": 123,
"addOnCreditsUsed": 123,
"billingCycleStart": "<string>",
"billingCycleEnd": "<string>"
}API de uso
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 --request POST \
--url https://server.codeium.com/api/v1/GetTeamCreditBalance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"service_key": "<string>"
}
'import requests
url = "https://server.codeium.com/api/v1/GetTeamCreditBalance"
payload = { "service_key": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({service_key: '<string>'})
};
fetch('https://server.codeium.com/api/v1/GetTeamCreditBalance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://server.codeium.com/api/v1/GetTeamCreditBalance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'service_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://server.codeium.com/api/v1/GetTeamCreditBalance"
payload := strings.NewReader("{\n \"service_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://server.codeium.com/api/v1/GetTeamCreditBalance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"service_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.codeium.com/api/v1/GetTeamCreditBalance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"service_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"promptCreditsPerSeat": 123,
"numSeats": 123,
"addOnCreditsAvailable": 123,
"addOnCreditsUsed": 123,
"billingCycleStart": "<string>",
"billingCycleEnd": "<string>"
}Visão geral
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
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
integer
Número de créditos de prompt alocados por assento no ciclo de faturamento atual
integer
Número de assentos na equipe
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.
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.
string
Início do ciclo de faturamento atual (timestamp ISO 8601)
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
- 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

