MrrByProduct
Use this when the user asks how MRR is distributed across products or plans. Requires permissions: subscriptions:read.
Authentication
sf_… API key in the bearerAuth field below.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.
In: header
Path Parameters
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/companies/string/data/mrrByProduct" \ -H "Content-Type: application/json" \ -d '{ "mrrType": "cmrr", "startDate": "string", "endDate": "string" }'nullMrrChangeEvents
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. Requires permissions: financials:read.