DevelopersAPIReferencedata
MrrData
Use this when the user asks how MRR has changed over time, MRR trend, or monthly recurring revenue history. Requires permissions: subscriptions:read.
Authentication
Checking whether you're signed in…
POST
header
Authorization<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.
companyId*stringLength
1 <= lengthapplication/json- body
mrrType*stringMRR variant. cmrr = committed MRR (CMRR), mrr = recognised MRR.
Value in
"cmrr""mrr"startDate?stringMatch
^\d{4}-\d{2}-\d{2}endDate?stringMatch
^\d{4}-\d{2}-\d{2}timeZone?stringIANA time zone. Defaults to BatchContext.timeZone, then UTC.
filterCustomerIds?array<string>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.
Default
nullmrrData result
application/json- response
[index: integer]?array<any>curl -X POST "https://example.com/companies/string/data/mrrData" \ -H "Content-Type: application/json" \ -d '{ "mrrType": "cmrr" }'[ [ "string", { "mrr": 0, "customerCount": 0 } ]]