本文へスキップ
CargoDuo logoCargoDuo
料金

このドキュメントは現在、英語版のみです。

開発者向けドキュメントAPI referenceAccount

Get the balance

Available, plan, purchased and reserved credits.

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
}

レスポンス

  • 200OKBalance.
    名前型必須説明
    available_creditsnumber · credits
    number · credits
    いいえ

    What new jobs can use (subscription + purchased − reserved).

    subscription_creditsnumber · credits
    number · credits
    いいえ

    Monthly subscription credits left (spent first; expire at subscription_expires_at).

    subscription_expires_atstring | null
    string | null
    いいえ

    When the monthly credits expire (RFC 3339).

    purchased_creditsnumber · credits
    number · credits
    いいえ

    Credits from packs (never expire).

    reserved_creditsnumber · credits
    number · credits
    いいえ

    Held by queued/running jobs.

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedMissing, malformed or unknown API key.
    • key_revokedThe key was revoked.
    • key_expiredThe key passed its expiry date.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowedThe calling IP is not on the key's allowlist.
    • subscription_inactiveThe organization has no active subscription that includes the API.
    • account_inactiveThe organization is suspended, or has no owner whose account is active.
    • scope_missingThe key lacks a scope this endpoint needs.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 429Too many requestsrate_limited
    • rate_limitedToo many requests in the current minute, hour or day (per key or per organization), or more than 60 failed authentications per minute from your IP address.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 500Internal server errorinternal_error
    • internal_errorSomething failed on our side.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード
  • 503Service unavailableapi_disabled
    • api_disabledThe API is temporarily disabled (maintenance) or switched off for the organization.
    名前型必須説明
    errorErrorBody必須
    ErrorBody
    はい
    すべてのエラーコード