CustomerMonthlyData
Use this when the user asks for one customer's month-by-month metrics or activity. For per-customer MRR in a month, request dataType "end" (MRR at month…
Authentication
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*stringuuidapplication/json- body
mrrType*stringMRR variant. cmrr = committed MRR (CMRR), mrr = recognised MRR.
"cmrr""mrr"startDate*string^\d{4}-\d{2}$endDate*string^\d{4}-\d{2}$dataType?stringSingle data type to fetch. "start" and "end" are the MRR at the period start/end month; the change types (new, reactivate, upgrade, downgrade, cancel, currency) are summed across the period.
"start""new""reactivate""upgrade""downgrade""cancel""currency""end"dataTypes?array<>Multiple data types; per-customer values are summed across the requested types. Takes precedence over dataType.
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.
nulltimeZone?stringIANA time zone. Defaults to BatchContext.timeZone, then UTC.
customerMonthlyData result
application/json- response
[index: integer]?curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/customerMonthlyData' \ -H 'Content-Type: application/json' \ -d '{ "mrrType": "cmrr", "startDate": "string", "endDate": "string"}'[ { "customerId": "string", "value": 0, "customer": { "name": "string", "externalIds": null }, "planChanges": [ { "predecessorSubscriptionId": "string", "successorSubscriptionId": "string", "linked": true } ] }]