Skip to content
Developer docsAPI referenceAccount

Get the balance

Available, plan, purchased and reserved credits.

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

Authentication

Bearer API key with scopeaccount:readLearn more

Example request

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

Example response

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
}

Responses

  • 200OKBalance.
    NameTypeRequiredDescription
    available_creditsnumber · credits
    number · credits
    No

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

    subscription_creditsnumber · credits
    number · credits
    No

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

    subscription_expires_atstring | null
    string | null
    No

    When the monthly credits expire (RFC 3339).

    purchased_creditsnumber · credits
    number · credits
    No

    Credits from packs (never expire).

    reserved_creditsnumber · credits
    number · credits
    No

    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.
    NameTypeRequiredDescription
    errorErrorBodyrequired
    ErrorBody
    Yes
    All error codes
  • 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.
    NameTypeRequiredDescription
    errorErrorBodyrequired
    ErrorBody
    Yes
    All error codes
  • 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.
    NameTypeRequiredDescription
    errorErrorBodyrequired
    ErrorBody
    Yes
    All error codes
  • 500Internal server errorinternal_error
    • internal_errorSomething failed on our side.
    NameTypeRequiredDescription
    errorErrorBodyrequired
    ErrorBody
    Yes
    All error codes
  • 503Service unavailableapi_disabled
    • api_disabledThe API is temporarily disabled (maintenance) or switched off for the organization.
    NameTypeRequiredDescription
    errorErrorBodyrequired
    ErrorBody
    Yes
    All error codes