Passer au contenu principal
POST
/
api
/
v1
/
GetTeamCreditBalance
Obtenir le solde des crédits de votre équipe
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>"
}

​
Vue d’ensemble

Récupérez les informations sur le solde de crédits actuel de votre équipe. Cela inclut les crédits de prompt alloués par siège, le nombre de sièges, l’utilisation des crédits supplémentaires et les dates du cycle de facturation.

​
Requête

​
service_key
string
requis
Votre clé de service disposant de la permission « Facturation Read »

​
Exemple de requête

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

​
Réponse

​
promptCreditsPerSeat
integer
Nombre de crédits de prompt alloués par place pour le cycle de facturation en cours
​
numSeats
integer
Nombre de places dans l’équipe
​
addOnCreditsAvailable
integer
Nombre total de crédits complémentaires disponibles pour l’équipe
​
addOnCreditsUsed
integer
Crédits complémentaires consommés à ce jour pendant le cycle de facturation en cours
​
billingCycleStart
string
Début du cycle de facturation en cours (horodatage ISO 8601)
​
billingCycleEnd
string
Fin du cycle de facturation en cours (horodatage ISO 8601)

​
Exemple de réponse

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

​
Réponses d’erreur

Scénarios d’erreur courants :
  • Clé de service invalide ou autorisations insuffisantes
  • Fonctionnalité non disponible pour votre offre (nécessite l’offre Enterprise)
  • Limite de requêtes dépassée