跳到主要内容
开发者文档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_allowed调用方 IP 不在该密钥的 IP 白名单中。
    • subscription_inactive组织没有包含 API 的有效订阅。
    • account_inactive组织已被暂停使用,或其所有者的账户均未处于有效状态。
    • scope_missing密钥缺少此接口所需的权限范围。
    名称类型必填说明
    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
    是
    全部错误码