Aller au contenu
Documentation développeursRéférence de l'APICompte

Consulter le solde

Crédits disponibles, du forfait, achetés et réservés.

GEThttps://runner.cargoduo.com/v1/balance

Authentification

Clé API Bearer avec l'autorisationaccount:readEn savoir plus

Exemple de requête

curl -X GET "https://runner.cargoduo.com/v1/balance" \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

Exemple de réponse

200 OK · Balance
{
  "available_credits": 147.75,
  "subscription_credits": 98.5,
  "subscription_expires_at": "2026-11-07T00:00:00Z",
  "purchased_credits": 50,
  "reserved_credits": 0.75
}

Réponses

  • 200OKSolde.
    NomTypeObligatoireDescription
    available_creditsnumber · credits
    number · credits
    Non

    Ce que les nouvelles tâches peuvent utiliser (abonnement + achetés − réservés).

    subscription_creditsnumber · credits
    number · credits
    Non

    Crédits mensuels de l'abonnement restants (utilisés en premier ; expirent à subscription_expires_at).

    subscription_expires_atstring | null
    string | null
    Non

    Date d'expiration des crédits mensuels (RFC 3339).

    purchased_creditsnumber · credits
    number · credits
    Non

    Crédits issus des recharges (n'expirent jamais).

    reserved_creditsnumber · credits
    number · credits
    Non

    Bloqués par les tâches en file d'attente ou en cours.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedClé API absente, mal formée ou inconnue.
    • key_revokedLa clé a été révoquée.
    • key_expiredLa clé a dépassé sa date d'expiration.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedL'adresse IP appelante ne figure pas dans la liste des adresses IP autorisées de la clé.
    • subscription_inactiveL'organisation n'a aucun abonnement actif incluant l'API.
    • account_inactiveL'organisation est suspendue ou n'a aucun propriétaire dont le compte est actif.
    • scope_missingIl manque à la clé une autorisation requise par cet endpoint.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur
  • 429Too many requestsrate_limited
    • rate_limitedTrop de requêtes dans la minute, l'heure ou la journée en cours (par clé ou par organisation), ou plus de 60 échecs d'authentification par minute depuis votre adresse IP.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur
  • 500Internal server errorinternal_error
    • internal_errorUne erreur s'est produite de notre côté.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur
  • 503Service unavailableapi_disabled
    • api_disabledL'API est temporairement désactivée (maintenance) ou désactivée pour l'organisation.
    NomTypeObligatoireDescription
    errorErrorBodyobligatoire
    ErrorBody
    Oui
    Tous les codes d'erreur