Skip to content

DocsAPI referenceAccount

The account's credits

The balance as of the last change in the billing ledger, less the credits of jobs that ended since; the credits running jobs hold; the grants with credits left and when they expire; for a subscriber, the cycle and its overage.

GET /v1/credits

Needs an API key: Authorization: Bearer $VIDEXO_API_KEY.

Request

bash
curl "$VIDEXO_API_URL/v1/credits" \
  -H "Authorization: Bearer $VIDEXO_API_KEY"

Response

200 JSON
{
  "plan": "payg",
  "balance": 26950.5,
  "reserved": 660,
  "available": 26290.5,
  "as_of": "2026-11-04T11:58:20.000Z",
  "buckets": [
    {
      "id": "cgr_free_9xk2",
      "kind": "free",
      "granted": 500,
      "remaining": 120.5,
      "granted_at": "2026-10-28T08:14:02.000Z",
      "expires_at": "2026-11-27T08:14:02.000Z"
    },
    {
      "id": "cgr_pack_4m7q",
      "kind": "top_up",
      "granted": 27500,
      "remaining": 26830,
      "granted_at": "2026-11-02T16:40:11.000Z",
      "expires_at": "2027-11-02T16:40:11.000Z"
    }
  ],
  "cycle": null,
  "overage": null
}

Responses

Responses
StatusBodyWhen
200CreditsThe account's credits.
401Problemauthentication_failed (missing_api_key, invalid_api_key, api_key_revoked, api_key_expired)
403Problempermission_denied (token_scope): a client token cannot call this route
429Problemrate_limited