Billing

Balance and settlement cutoff timestamp

get/balance

Request

  • Base URL: https://console-api.blockvectra.com/v1
  • URL: https://console-api.blockvectra.com/v1/balance
  • Auth: HTTP bearer

Response

Balance.

balance_unitsinteger required

Settled balance (amount_units), can be negative. On free plan, remaining free grant constitutes this balance (free accounts have no paid top-ups; balance derived from grants).

balance_updated_atstring date-time required

RFC 3339 UTC, second precision, ending in Z (2026-09-26T08:00:00Z); no fractional seconds, without +00:00 timezone offsets.

settled_throughstring date-time required

RFC 3339 UTC, second precision, ending in Z (2026-09-26T08:00:00Z); no fractional seconds, without +00:00 timezone offsets.

plan'free' | 'paid' required

Account plan: free (free tier, no paid top-ups) or paid (paid tier, after first paid top-up).

free_monthly_unitsinteger nullable required

Free balance replenishment target (amount_units); null for paid tier. The historical field name does not imply a calendar month. At the end of a usage-started window (currently 30 days), eligible free accounts below the target are topped up to it; no accumulation or reduction of remaining credit.

max_calls_per_secinteger nullable required

Per-second call limit per account for free tier; null for paid tier. Token bucket capacity and refill rate equal this value, shared across all keys, chains, and Data API for the account. Each call in batch counted individually.

free_window_ends_atstring date-time required

RFC 3339 UTC, second precision, ending in Z (2026-09-26T08:00:00Z); no fractional seconds, without +00:00 timezone offsets.

Example response

{
  "balance_updated_at": "2026-09-26T08:00:00Z",
  "settled_through": "2026-09-26T08:00:00Z",
  "free_window_ends_at": "2026-09-26T08:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.