Billing
Your balance, and your financial documents, such as invoices, to list, read and download.
Read the organization's Treasury balance
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Read the organization's Treasury balance › Responses
The live Treasury balance.
as_ofavailable_minorCalls refused since the hard stop began; not counted on this route yet, so always null.
capacity_minorWhen cash went below zero; not recorded yet, so always null.
cash_minorcredit_limit_minorcurrencyHours until available cash runs out at the current spend; not estimated yet, so always null.
exponentexposure_minorholds_minoridliveThe balance below which the account counts as low; not configurable yet, so always null.
The code calls are refused with during a stop; not reported here yet, so always null.
When calls began to be refused; not reported here yet, so always null.
reserved_cash_minorHow many live calls hold reserved cash; not counted yet, so always null.
revisionstatestatusThe suspension in force on the account; not reported yet, so always null.
The unpaid invoice holding the account; not reported yet, so always null.
List immutable customer financial documents
query Parameters
kindstatusperiodHeaders
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
List immutable customer financial documents › Responses
The matching documents and per-kind counts.
as_ofcurrencyexponentinvoicedRead one immutable customer financial document
path Parameters
document_idBilling document id
Headers
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Read one immutable customer financial document › Responses
The statement or invoice, tagged by kind.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: statement, kind | |
| type = object · requires: invoice, kind |
kindDownload a financial document from its frozen lines
path Parameters
document_idBilling document id
query Parameters
formatHeaders
Signals-VersionThe supported API snapshot to use for this request.
X-Project-IDThe project the request acts on, as prj_ and its lowercase UUID; optional while the
organization has one active project.
Download a financial document from its frozen lines › Responses
The document lines as UTF-8 CSV.