Sign in
Accounts

Get all monthly usage for an account.

Returns raw metric quantities from one ClickHouse query. No PostgreSQL query is performed.

get/v2/accounts/{account_id}/usage/monthly

Path parameters

account_idstring required

LedgerUp account identifier.

Example:account_0194f4e3a2b77c6aa91c4f6b4db2a980

Query parameters

aggregation'sum' | 'min' | 'max' | 'avg' | 'latest' | 'count'

Aggregation applied to corrected usage events. latest returns the quantity from the event with the latest occurred_at; ties use accepted_at then event ID. count returns the number of events.

Example:sum
currencystring
Example:usd

Aggregate only events for this currency. Normalized to lowercase.

Response

Account usage grouped by UTC calendar month and metric.

aggregation'sum' | 'min' | 'max' | 'avg' | 'latest' | 'count' required

Aggregation applied to corrected usage events. latest returns the quantity from the event with the latest occurred_at; ties use accepted_at then event ID. count returns the number of events.

Example response

{
  "aggregation": "sum",
  "data": [
    {
      "period_start_at": 1767225600,
      "data": [
        {
          "metric_id": "metric_0194f4e3a2b77c6aa91c4f6b4db2a980",
          "currency": "usd",
          "quantity": "1250.5"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.