Skip to Content
SaaSFlow
DevelopersAPIReferencedata

MrrChangeEvents

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

Authentication

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

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
Formatuuid

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}-\d{2}
endDate*string
Match^\d{4}-\d{2}-\d{2}
limit?integer
Range1 <= value
offset?integer
Range0 <= value
timeZone?string

IANA 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.

Defaultnull

Response Body

mrrChangeEvents result

application/json
  1. response
events*array<unknown>
totalCount*number
Example Request
curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/mrrChangeEvents' \  -H 'Content-Type: application/json' \  -d '{  "mrrType": "cmrr",  "startDate": "string",  "endDate": "string"}'
Example Response
{  "events": [    null  ],  "totalCount": 0}