Skip to content
Doprax DocsDoprax DocsDoprax Docs

v2_finance_summary_retrieve

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

Billing summary, including runway_days — an estimate of how many days the current balance will last at the account’s burn rate.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
refresh_alerts
boolean

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
success
required
boolean
data
required
object
currency
string
balance_cents
integer
available_balance_cents
integer
accrued_cents
integer
recurring_cents
integer
usage_cents
integer
burn_rate_cents
integer
runway_days
integer
nullable
exhaustion_date
string
nullable
base_monthly_cents
integer
base_daily_cents
integer
cost_ratio
number format: double
reserved_cents
integer
pending_cents
integer
credit_cents
integer
promo_cents
integer
bonus_cents
integer

Example generated

{
  "success": true,
  "data": {
    "currency": "example",
    "balance_cents": 1,
    "available_balance_cents": 1,
    "accrued_cents": 1,
    "recurring_cents": 1,
    "usage_cents": 1,
    "burn_rate_cents": 1,
    "runway_days": 1,
    "exhaustion_date": "example",
    "base_monthly_cents": 1,
    "base_daily_cents": 1,
    "cost_ratio": 1,
    "reserved_cents": 1,
    "pending_cents": 1,
    "credit_cents": 1,
    "promo_cents": 1,
    "bonus_cents": 1
  }
}