Account

Get Credit Balance

Changed on

Retrieves the current account's available credit balance and expected next recurring credit grant time.

The balance is a near-real-time hint and can lag one in-flight metered operation. A 402 response from an operation is authoritative when deciding whether more credits are required. Negative ledger balances are returned as 0 available credits.

next_grant_at comes from the account's billing schedule, not an existing grant's expiration. It is null when no scheduled grant can be determined. Processing may occur later, and other grants may arrive sooner.

Requires api token with one of the following permissions

(any scope allowed)

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. The account is always derived from the authenticated token; this endpoint does not accept an account identifier.

Expiring access tokens created with authorizations cannot be used: this endpoint responds with a 403, whatever the authorizations grant.

get/credits/balance

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/credits/balance
  • Auth
    HTTP bearer

Headers

X-Wistia-API-Versionstring required

Response

Successful response

balancestring required

Available Credits as an exact, nonnegative decimal string.

next_grant_atstring date-time nullable required

Expected next recurring Credits grant boundary from the account's billing schedule, as an ISO 8601 timestamp. Null when no scheduled grant can be determined. Processing may occur later, and other grants may arrive sooner.

Example response

{
  "balance": "1250.0"
}

Changes