Przejdź do treści
Dokumentacja dla deweloperówDokumentacja APIKonto

Pobierz saldo

Kredyty dostępne, z pakietu, kupione i zarezerwowane.

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

Uwierzytelnianie

Klucz API (Bearer) z zakresemaccount:readWięcej informacji

Przykładowe zapytanie

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

Przykładowa odpowiedź

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
}

Odpowiedzi

  • 200OKSaldo.
    NazwaTypWymaganyOpis
    available_creditsnumber · credits
    number · credits
    Nie

    Kredyty, z których mogą korzystać nowe zadania (subskrypcja + kupione − zarezerwowane).

    subscription_creditsnumber · credits
    number · credits
    Nie

    Pozostałe miesięczne kredyty z subskrypcji (zużywane jako pierwsze; wygasają w chwili subscription_expires_at).

    subscription_expires_atstring | null
    string | null
    Nie

    Kiedy wygasają kredyty miesięczne (RFC 3339).

    purchased_creditsnumber · credits
    number · credits
    Nie

    Kredyty z doładowań (nigdy nie wygasają).

    reserved_creditsnumber · credits
    number · credits
    Nie

    Zablokowane przez zadania w kolejce lub w toku.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedBrak klucza API, nieprawidłowy format klucza lub nieznany klucz.
    • key_revokedKlucz został unieważniony.
    • key_expiredKlucz utracił ważność.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedAdresu IP, z którego przyszło wywołanie, nie ma na liście dozwolonych adresów klucza.
    • subscription_inactiveOrganizacja nie ma aktywnej subskrypcji obejmującej API.
    • account_inactiveOrganizacja jest zawieszona albo nie ma właściciela z aktywnym kontem.
    • scope_missingKlucz nie ma zakresu wymaganego przez ten endpoint.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 429Too many requestsrate_limited
    • rate_limitedZa dużo zapytań w bieżącej minucie, godzinie lub dobie (na klucz lub na organizację) albo przekroczony limit nieudanych uwierzytelnień z Twojego adresu IP (60 na minutę).
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 500Internal server errorinternal_error
    • internal_errorWystąpił błąd po naszej stronie.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów
  • 503Service unavailableapi_disabled
    • api_disabledAPI jest tymczasowo wyłączone (prace konserwacyjne) lub wyłączone dla organizacji.
    NazwaTypWymaganyOpis
    errorErrorBodywymagane
    ErrorBody
    Tak
    Wszystkie kody błędów