v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB

Reports

Retrieves ARR waterfall report

Returns the ARR waterfall dataset for the requested month with optional breakdown dimensions, subsidiary filters, and pagination cursors for large tenants. Finance teams use this to explain beginning ARR, new business, expansion, contraction, and churn between periods.

get/reports/arr-waterfall

Query parameters

monthstring yearMonth required

The month and year to export. Uses ISO-8061 format (YYYY-MM).

status'ACTIVE' | 'COMMITTED' required

whether to include committed or active entries

breakdown'ARR' | 'MRR' required

whether annual or monthly breakdowns

subsidiary_idstring uuid

Subsidiary to be used when filtering data

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

Response

Example response

{
  "customers": [
    {
      "total": {
        "amount": {
          "amount": "1.01",
          "currency": "USD"
        }
      }
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}