v1

latestOpenAPI 3.1.02026-08-06213193627.0 KB
billing

Get Org Balance And Subscription Details

Gets the balance and subscription settings

get/v1/billing

Response

Successful Response

spending_limit_softnumber

When the balance crosses this value, a warning email will be sent informing the customer

spending_limit_hardnumber

When the balance crosses this value, a high-warning email will be sent informing the customer that services will be disrupted if the balance reaches 0

currency'usd'

The currency of the organization

balancenumber

The balance in the account. Synced with Stripe periodically

last_invoice_dateinteger required

The timestamp when the local balance (i.e. the value we keep track of) was synced with stripe (and the customer was billed)

billing_zipstring nullable required

The Zipcode of the address of the Organization

trial_endstring date-time nullable

The datetime when the trial ends (or None, if the user is not in a trial)

trial_ending_soonboolean

When the trial is coming to an end, we notify the Frontend (calculated on the server side)