Get profitability summary
Returns a per-customer profitability summary for a merchant over a date range. Each row aggregates revenue (from issued + paid invoices), cost (from metered cost discovery), profit, and margin. Customers are ranked by profit descending and capped at topN; the remainder is rolled into a single self-consistent ‘Other’ row whose revenue, cost, and profit reflect the same set of customers. Rows are inner-joined against the merchant’s customer list, so orphaned meter subjects from deleted or unknown customers are dropped.
Authorizations
API key authentication
Query Parameters
Merchant whose customers to summarize Unique identifier for an organization
^org_[a-zA-Z0-9]+$Start of the time range (ISO 8601 format)
End of the time range (ISO 8601 format)
Number of top customers (by profit) to return individually. The rest are rolled into a single 'Other' row.
1 <= x <= 100ISO 4217 currency code to scope the summary. Defaults to the merchant's primary currency.
3Time bucket granularity for the per-customer revenue trend. When omitted, the server picks a reasonable bucket from the window length.
hour, day, week Response
Profitability summary
Object type identifier
"profitability_summary"ISO 4217 currency code applied to revenue and cost values
Top-N customer rows by profit descending, optionally followed by a single 'Other' row when more than topN customers contributed.
101Non-fatal warnings collected during cost discovery (e.g. an individual cost query failed). Empty array on a clean run.
100