Overview

SaaS metrics envelope (AR turnover, MRR, LTV, CAC)

Returns the Home "SaaS Metrics" row. enabled reflects the home_saas_metrics rollout flag. Each metric also carries its own available: AR turnover is computed from the GL today; MRR reports the final sealed snapshot of the last completed calendar month (asOf; the current partial month is excluded) — this covers currentMinorUnits and the five waterfall components (new / expansion / reactivation / contraction / churned), while projectedMinorUnits and contractedMinorUnits stay deliberately FORWARD-LOOKING and are derived from live subscription state, not from the completed-month snapshot; LTV reads the entity's authoritative MRR snapshots plus its posted P&L gross margin and returns available:false with a reason when an input is missing (see LtvMetric). enabled reflects the home_saas_metrics rollout flag as UI-visibility metadata only — it never changes the computed result. When a metric is unavailable the UI shows an honest empty state (no fabricated numbers). The envelope-level currency / mixedCurrencies fields (additive) report the subscriptions' single authoritative billing currency: currency is null — never an assumed USD — when there are no subscriptions, the source is unwired, or currencies are mixed (mixedCurrencies: true). The envelope is ENTITY-scoped: entityId is a required concrete legal entity from the caller's authorized scope (a sole authorized entity is resolved automatically; a multi-entity actor without a selection gets a 422, and an unauthorized entity is rejected). Cross-entity sums without a consolidation authority are never fabricated.

get/companies/{companyId}/metrics/saas

Request

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

Query parameters

entityIdstring uuid required

Concrete authorized legal entity whose SaaS metrics are requested.

asOfstring date

Optional YYYY-MM-DD clock override; the MRR fields describe the last completed calendar month strictly before this date's month (defaults to the server's UTC now).

Response

SaaS metrics payload

successtrue required

Example response

{
  "data": {
    "mrr": {
      "live": {
        "month": "2026-09"
      }
    }
  }
}

Changes

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