DevelopersAPIReferencedata
CustomerMrr
Use this when the user asks for MRR broken down per customer, or which customers contribute the most MRR. 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*stringFormat
uuidapplication/json- body
mrrType*stringMRR variant. cmrr = committed MRR (CMRR), mrr = recognised MRR.
Value in
"cmrr""mrr"date*stringMatch
^\d{4}-\d{2}-\d{2}limit?integerRange
1 <= valueoffset?integerRange
0 <= valuetimeZone?stringIANA time zone. Defaults to BatchContext.timeZone, then UTC.
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
nullcustomerMrr result
application/json- response
customers*array<>totalCount*numbercurl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/customerMrr' \ -H 'Content-Type: application/json' \ -d '{ "mrrType": "cmrr", "date": "string"}'Example Response
{ "customers": [ { "customerId": "string", "value": 0, "customer": { "name": "string", "countryCode": "string", "logoUrl": "string" } } ], "totalCount": 0}