Get balance (GET /v1/account/balance)

GET/v1/account/balance

The Customer's prepaid Balance in Credits, and each unexpired Grant (such as the Starter Grant) with its remaining Credits and expiry. Grants are part of the Balance and are spent first.

Price

Free.

Responses

200 OK

{ balance_credits, grants }.

object

balance_creditsintegerrequiredThe spendable Balance in Credits: active Grants included, an expired Grant's leftover never.
grantsarray of objectrequiredUnexpired Grants with Credits left, soonest expiry first. Their Credits are part of the Balance and are spent before purchased Credits, which never expire.
- sourcestringrequiredone of starter, bonusstarter for the Starter Grant, bonus for any other.
- amount_creditsintegerrequiredCredits granted.
- remaining_creditsintegerrequiredCredits of this Grant not yet spent.
- expires_atstringrequiredWhen any remainder leaves the Balance.

200 · `{ balance_credits, grants }`.

{
  "balance_credits": 42310,
  "grants": [
    {
      "source": "starter",
      "amount_credits": 100,
      "remaining_credits": 64,
      "expires_at": "2026-10-01T00:00:00.000Z"
    }
  ]
}

401 Unauthorized

missing_authorization, invalid_key, key_revoked or invalid_token.

object

RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.

typestringrequired
titlestringrequired
statusintegerrequired
codestringrequiredone of missing_authorization, invalid_key, key_revoked, invalid_token, organization_not_selected, organization_access_revoked, connection_revoked, forbidden, invalid_request, unsupported_platform, unsupported_kind, kind_deprecated, not_found, video_too_long, idempotency_conflict, run_not_ready, advertiser_ambiguous, insufficient_balance, rate_limit_exceeded, concurrency_limit_exceeded, tracker_limit_exceeded, webhook_limit_exceeded, webhook_rotation_in_progress, collection_limit_exceeded, collection_name_taken, collection_kind_mismatch, media_unavailable, vendor_error, source_unavailable, service_unavailable, internal_errorStable machine-readable code.
detailstring

401 · Example

{
  "type": "https://www.shortsintel.com/docs/reference/errors/invalid_key",
  "title": "Invalid key",
  "status": 401,
  "code": "invalid_key",
  "detail": "That API key does not exist. Keys look like `sk_live_...` and are created in the console."
}

Request samples

curl "https://www.shortsintel.com/v1/account/balance" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

const response = await fetch(
  "https://www.shortsintel.com/v1/account/balance",
  {
    method: "GET",
    headers: {
      "Authorization": "Bearer sk_live_YOUR_KEY",
    },
  },
);

if (!response.ok) {
  throw new Error(`ShortsIntel ${response.status}`);
}

const data = await response.json();

import requests

response = requests.get(
    "https://www.shortsintel.com/v1/account/balance",
    headers={
        "Authorization": "Bearer sk_live_YOUR_KEY",
    },
)
response.raise_for_status()

data = response.json()