Read this tenant's budget

GET

/v1/billing/budget

curl --request GET \
  --url https://api.vocapable.com/v1/billing/budget \
  --header 'Authorization: Bearer <token>'

Authorizations

• HTTPBearer

Responses

200

Successful Response

Media typeapplication/json

Budget

The tenant’s budget as stored, plus what it has spent against it so far.

object

currency

required

Currency

string

balance_minor

required

Balance Minor

integer

spend_cap_minor

required

Any of:

integer

integer

null

null

spend_cap_period

required

Any of:

string

string

null

null

low_balance_threshold_minor

required

Any of:

integer

integer

null

null

period_spend_minor

required

Any of:

integer

integer

null

null

unpriced_meters

required

Unpriced Meters

Array<string>

Example^generated

{
  "currency": "example",
  "balance_minor": 1,
  "spend_cap_minor": 1,
  "spend_cap_period": "example",
  "low_balance_threshold_minor": 1,
  "period_spend_minor": 1,
  "unpriced_meters": [
    "example"
  ]
}