Skip to content
Doprax DocsDoprax DocsDoprax Docs

v2_finance_available_balance_retrieve

GET
/api/v2/finance/available-balance/
curl --request GET \
  --url https://example.com/api/v2/finance/available-balance/ \
  --header 'X-API-Key: <X-API-Key>'

Check available account balance against an optional minimum required amount before creating or starting a VM.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
action
string
min_required_cents
integer
refresh
boolean
refresh_alerts
boolean

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
success
required
boolean
data
required
object
currency
required
string
available_balance_cents
required
integer
accrued_cents
required
integer
recurring_cents
required
integer
usage_cents
required
integer
min_required_cents
required
integer
nullable
is_sufficient
required
boolean
nullable
default_min_required_cents
required
integer

Example generated

{
  "success": true,
  "data": {
    "currency": "example",
    "available_balance_cents": 1,
    "accrued_cents": 1,
    "recurring_cents": 1,
    "usage_cents": 1,
    "min_required_cents": 1,
    "is_sufficient": true,
    "default_min_required_cents": 1
  }
}