Get consumer overview
LogsGET /overview
Amount due, latest reading and consumption series per linked account
Returns a dashboard summary across every account linked to the caller: the total amount due, and per account the open invoice count and balance, the latest meter reading and a consumption series of up to the last 12 periods. Accounts in different tenants are included together.
Returns
200 Overview
Show attributes
amount_due_centscurrencyaccountsShow child attributes
tenant_idaccount_idaccount_numberamount_due_centscurrencyopen_invoiceslatest_readinglast_invoiceThe most recently issued invoice on the account; absent when none was issued
Show child attributes
idinvoice_numbertotal_centsbalance_centscurrencystatusissued_atdue_date
consumption_seriesShow child attributes
datevalue
curl -X GET "$CONSUMER_API/overview" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$CONSUMER_API/overview", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$CONSUMER_API/overview",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$CONSUMER_API/overview", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
Response 200
{
"amount_due_cents": 125000,
"currency": "MZN",
"accounts": [
{
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
"account_number": "ACC-2026-000142",
"amount_due_cents": 125000,
"currency": "MZN",
"open_invoices": 1,
"latest_reading": {},
"last_invoice": {
"id": "con_244XPeIpRs4LdYuX5O0xxWqvfEU",
"invoice_number": "INV-2026-000142",
"total_cents": 125000,
"balance_cents": 125000,
"currency": "MZN",
"status": "active",
"issued_at": "2026-11-19T09:30:00Z",
"due_date": "2026-11-19T09:30:00Z"
},
"consumption_series": [
{
"date": "2026-11-19",
"value": 13.42
}
]
}
]
}