Перейти к содержимому
CargoDuo logoCargoDuo
Цены
Документация для разработчиковСправочник APIАккаунт

Получить баланс

Доступные кредиты, кредиты тарифа, купленные и зарезервированные кредиты.

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

Аутентификация

Bearer-ключ API с правомaccount:readПодробнее

Пример запроса

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

Пример ответа

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
}

Ответы

  • 200OKБаланс.
    ИмяТипОбязательноОписание
    available_creditsnumber · credits
    number · credits
    Нет

    Сколько кредитов доступно новым заданиям (тариф + купленные − зарезервированные).

    subscription_creditsnumber · credits
    number · credits
    Нет

    Остаток ежемесячных кредитов тарифа (расходуются первыми; сгорают в момент subscription_expires_at).

    subscription_expires_atstring | null
    string | null
    Нет

    Когда сгорают ежемесячные кредиты (RFC 3339).

    purchased_creditsnumber · credits
    number · credits
    Нет

    Кредиты из пакетов (не сгорают).

    reserved_creditsnumber · credits
    number · credits
    Нет

    Удерживаются заданиями в очереди и в работе.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedAPI-ключ отсутствует, имеет неверный формат или неизвестен.
    • key_revokedКлюч отозван.
    • key_expiredСрок действия ключа истёк.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedIP-адреса вызывающей стороны нет в списке разрешённых IP для этого ключа.
    • subscription_inactiveУ организации нет активной подписки, включающей API.
    • account_inactiveРабота организации приостановлена, или у неё нет владельца с активной учётной записью.
    • scope_missingУ ключа нет области доступа, необходимой для этого endpoint.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок
  • 429Too many requestsrate_limited
    • rate_limitedСлишком много запросов за текущую минуту, час или сутки (на ключ или на организацию) либо число неудачных попыток аутентификации с вашего IP-адреса превысило 60 в минуту.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок
  • 500Internal server errorinternal_error
    • internal_errorСбой на нашей стороне.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок
  • 503Service unavailableapi_disabled
    • api_disabledAPI временно отключён (техническое обслуживание) или выключен для организации.
    ИмяТипОбязательноОписание
    errorErrorBodyобязательно
    ErrorBody
    Да
    Все коды ошибок