Bỏ qua đến nội dung
CargoDuo logoCargoDuo
Bảng giá
Tài liệu cho nhà phát triểnTham chiếu APITài khoản

Xem số dư

Credit khả dụng, credit của gói, credit đã mua và credit đang tạm giữ.

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

Xác thực

Khóa API dạng Bearer, phạm vi quyềnaccount:readTìm hiểu thêm

Yêu cầu mẫu

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

Phản hồi mẫu

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
}

Phản hồi

  • 200OKSố dư.
    TênKiểuBắt buộcMô tả
    available_creditsnumber · credits
    number · credits
    Không

    Số credit tác vụ mới có thể dùng (gói đăng ký + đã mua − đang tạm giữ).

    subscription_creditsnumber · credits
    number · credits
    Không

    Credit hằng tháng còn lại của gói đăng ký (được dùng trước; hết hạn tại subscription_expires_at).

    subscription_expires_atstring | null
    string | null
    Không

    Thời điểm credit hằng tháng hết hạn (RFC 3339).

    purchased_creditsnumber · credits
    number · credits
    Không

    Credit từ các lần nạp (không bao giờ hết hạn).

    reserved_creditsnumber · credits
    number · credits
    Không

    Đang bị tạm giữ bởi các tác vụ đang chờ/đang chạy.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedThiếu khóa API, khóa sai định dạng hoặc không xác định.
    • key_revokedKhóa đã bị thu hồi.
    • key_expiredKhóa đã quá ngày hết hạn.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedIP gọi đến không nằm trong danh sách IP được phép của khóa.
    • subscription_inactiveTổ chức không có gói đăng ký đang hoạt động nào bao gồm API.
    • account_inactiveTổ chức bị tạm ngưng, hoặc không có chủ sở hữu nào có tài khoản đang hoạt động.
    • scope_missingKhóa thiếu phạm vi quyền mà endpoint này yêu cầu.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi
  • 429Too many requestsrate_limited
    • rate_limitedQuá nhiều yêu cầu trong phút, giờ hoặc ngày hiện tại (theo khóa hoặc theo tổ chức), hoặc có hơn 60 lần xác thực thất bại mỗi phút từ địa chỉ IP của bạn.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi
  • 500Internal server errorinternal_error
    • internal_errorĐã xảy ra lỗi ở phía chúng tôi.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi
  • 503Service unavailableapi_disabled
    • api_disabledAPI tạm thời bị tắt (bảo trì) hoặc đã bị tắt cho tổ chức.
    TênKiểuBắt buộcMô tả
    errorErrorBodybắt buộc
    ErrorBody
    Có
    Tất cả mã lỗi