İçeriğe atla
Geliştirici dokümanlarıAPI referansıHesap

Bakiyeyi getir

Kullanılabilir, paket, satın alınan ve rezerve edilen krediler.

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

Kimlik doğrulama

Bearer API anahtarı, gereken yetki:account:readDaha fazla bilgi

Örnek istek

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

Örnek yanıt

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
}

Yanıtlar

  • 200OKBakiye.
    AdTürZorunluAçıklama
    available_creditsnumber · credits
    number · credits
    Hayır

    Yeni işlerin kullanabileceği kredi (abonelik + satın alınan − rezerve edilen).

    subscription_creditsnumber · credits
    number · credits
    Hayır

    Kalan aylık abonelik kredisi (önce bu harcanır; süresi subscription_expires_at anında dolar).

    subscription_expires_atstring | null
    string | null
    Hayır

    Aylık kredilerin süresinin dolacağı zaman (RFC 3339).

    purchased_creditsnumber · credits
    number · credits
    Hayır

    Kredi paketlerinden gelen krediler (süresi dolmaz).

    reserved_creditsnumber · credits
    number · credits
    Hayır

    Sıradaki/çalışan işler için rezerve edilen krediler.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedAPI anahtarı eksik, hatalı biçimde ya da tanınmıyor.
    • key_revokedAnahtar iptal edildi.
    • key_expiredAnahtarın geçerlilik süresi doldu.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedİsteği gönderen IP, anahtarın izin listesinde değil.
    • subscription_inactiveOrganizasyonun API'yi içeren etkin bir aboneliği yok.
    • account_inactiveOrganizasyon askıya alınmış ya da hesabı etkin olan bir organizasyon sahibi yok.
    • scope_missingAnahtarda bu endpoint'in gerektirdiği bir yetki eksik.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 429Too many requestsrate_limited
    • rate_limitedGeçerli dakika, saat ya da gün içinde çok fazla istek gönderildi (anahtar ya da organizasyon başına) veya IP adresinizden gelen başarısız kimlik doğrulama denemeleri dakikada 60 sınırını aştı.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 500Internal server errorinternal_error
    • internal_errorBizim tarafımızda bir hata oluştu.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları
  • 503Service unavailableapi_disabled
    • api_disabledAPI geçici olarak devre dışı (bakım) ya da organizasyon için kapatılmış.
    AdTürZorunluAçıklama
    errorErrorBodyzorunlu
    ErrorBody
    Evet
    Tüm hata kodları