SaaSFlow
DevelopersAPIReferencedata

MrrByProduct

Use this when the user asks how MRR is distributed across products or plans. Requires permissions: subscriptions:read.

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/data/mrrByProduct

Authorization

headerAuthorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

Path Parameters

companyId*string
Length1 <= length

Request Body

application/json
  1. body
mrrType*string

MRR variant. cmrr = committed MRR (CMRR), mrr = recognised MRR.

Value in"cmrr""mrr"
startDate*string
Match^\d{4}-\d{2}$
endDate*string
Match^\d{4}-\d{2}$
productIds?array<string>|

Restrict subscription metrics to these product ids. Omit or null for all products. Values are unioned; a customer on several selected products counts once.

Defaultnull

Response Body

mrrByProduct result

response?unknownapplication/json
curl -X POST "https://example.com/companies/string/data/mrrByProduct" \  -H "Content-Type: application/json" \  -d '{    "mrrType": "cmrr",    "startDate": "string",    "endDate": "string"  }'
null

MrrChangeEvents

Use this when the user asks for individual MRR change events (new, expansion, contraction, churn) in a period. Requires permissions: subscriptions:read.

Analytics

Use this when the user asks for summary SaaS metrics (MRR, ARR, NRR, GRR, churn, LTV, CAC, burn rate, runway) over a period.