Overview

Base URL: $CONSUMER_API

The object

amount_due_centsinteger (int64) · optional
currencystring · optional
accountsarray of object · optional
Show child attributes
tenant_idstring · optional
account_idstring · optional
account_numberstring · optional
amount_due_centsinteger · optional
currencystring · optional
open_invoicesinteger · optional
latest_readingobject · optional
last_invoiceobject · optional

The most recently issued invoice on the account; absent when none was issued

Show child attributes
idstring · optional
invoice_numberstring · optional
total_centsinteger · optional
balance_centsinteger · optional
currencystring · optional
statusstring · optional
issued_atstring (date-time) · optional
due_datestring (date-time) · optional
consumption_seriesarray of SeriesPoint · optional
Show child attributes
datestring (date) · optional
valuenumber · optional
Endpoints
The object
{
  "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
        }
      ]
    }
  ]
}

Get consumer overview

Logs

GET /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_centsinteger (int64) · optional
currencystring · optional
accountsarray of object · optional
Show child attributes
tenant_idstring · optional
account_idstring · optional
account_numberstring · optional
amount_due_centsinteger · optional
currencystring · optional
open_invoicesinteger · optional
latest_readingobject · optional
last_invoiceobject · optional

The most recently issued invoice on the account; absent when none was issued

Show child attributes
idstring · optional
invoice_numberstring · optional
total_centsinteger · optional
balance_centsinteger · optional
currencystring · optional
statusstring · optional
issued_atstring (date-time) · optional
due_datestring (date-time) · optional
consumption_seriesarray of SeriesPoint · optional
Show child attributes
datestring (date) · optional
valuenumber · optional
curl -X GET "$CONSUMER_API/overview" \
  -H "Authorization: Bearer sk_test_..."
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
        }
      ]
    }
  ]
}