Zum Inhalt springen
EntwicklerdokumentationAPI-ReferenzKonto

Guthaben abrufen

Verfügbare, Tarif-, gekaufte und reservierte Credits.

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

Authentifizierung

Bearer-API-Schlüssel mit Berechtigungaccount:readMehr erfahren

Beispielanfrage

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

Beispielantwort

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
}

Antworten

  • 200OKGuthaben.
    NameTypErforderlichBeschreibung
    available_creditsnumber · credits
    number · credits
    Nein

    Was neue Jobs nutzen können (Abonnement + gekauft − reserviert).

    subscription_creditsnumber · credits
    number · credits
    Nein

    Verbleibende monatliche Abo-Credits (werden zuerst verbraucht; verfallen zu subscription_expires_at).

    subscription_expires_atstring | null
    string | null
    Nein

    Zeitpunkt, zu dem die monatlichen Credits verfallen (RFC 3339).

    purchased_creditsnumber · credits
    number · credits
    Nein

    Credits aus Paketen (verfallen nie).

    reserved_creditsnumber · credits
    number · credits
    Nein

    Von wartenden/laufenden Jobs reserviert.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedAPI-Schlüssel fehlt, ist fehlerhaft oder unbekannt.
    • key_revokedDer Schlüssel wurde widerrufen.
    • key_expiredDer Schlüssel ist abgelaufen.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedDie aufrufende IP-Adresse steht nicht auf der Allowlist des Schlüssels.
    • subscription_inactiveDie Organisation hat kein aktives Abonnement, das die API enthält.
    • account_inactiveDie Organisation ist gesperrt oder hat keinen Inhaber mit aktivem Konto.
    • scope_missingDem Schlüssel fehlt eine Berechtigung, die dieser Endpoint benötigt.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 429Too many requestsrate_limited
    • rate_limitedZu viele Anfragen in der aktuellen Minute, Stunde oder am aktuellen Tag (pro Schlüssel oder pro Organisation) oder mehr als 60 fehlgeschlagene Authentifizierungen pro Minute von Ihrer IP-Adresse.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 500Internal server errorinternal_error
    • internal_errorAuf unserer Seite ist ein Fehler aufgetreten.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes
  • 503Service unavailableapi_disabled
    • api_disabledDie API ist vorübergehend deaktiviert (Wartung) oder für die Organisation abgeschaltet.
    NameTypErforderlichBeschreibung
    errorErrorBodyerforderlich
    ErrorBody
    Ja
    Alle Fehlercodes