Overview

Monthly MRR waterfall history

Returns the monthly MRR movement history behind the Home MRR-movements widget and the Recurring-revenue report. enabled reflects the home_saas_metrics rollout flag; available requires monthly snapshots and one authoritative billing currency. unavailableReason explains when mixed or unknown currency makes the history unsafe to present. Months are ascending; every amount is an exact base-10 minor-unit integer string under the root currency and minor-unit exponent. Waterfall components (new / expansion / reactivation / contraction / churned) are non-negative magnitudes and netNewMrrMinorUnits nets them. The current partial UTC month is excluded from every window before slicing; asOf and period name the resolved completed-month range. enabled reflects the home_saas_metrics rollout flag as UI-visibility metadata only — it never changes the computed result.

get/companies/{companyId}/metrics/mrr-movements

Request

  • Base URL: https://api.medianfi.com/api/v1
  • URL: https://api.medianfi.com/api/v1/companies/{companyId}/metrics/mrr-movements
  • Auth: HTTP bearer

Query parameters

entityIdstring uuid required

Concrete authorized legal entity whose MRR history is requested.

monthsinteger

Trailing window of months to return.

Response

MRR movements payload

successtrue required

Example response

{
  "data": {
    "period": {
      "startMonth": "2025-08",
      "endMonth": "2026-07",
      "monthKeys": [
        "2026-07"
      ]
    },
    "historyCompleteFrom": "2025-11",
    "months": [
      {
        "month": "2026-06"
      }
    ],
    "coverageGaps": [
      "2026-09"
    ],
    "labelledGaps": [
      {
        "month": "2026-09"
      }
    ],
    "seam": {
      "month": "2026-10"
    }
  }
}

Changes

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