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

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
POST
/companies/{companyId}/data/mrrChangeEvents

Authorization

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.

In: header

Path Parameters

companyId*string
Length1 <= length

Request 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/mrrChangeEvents" \  -H "Content-Type: application/json" \  -d '{    "mrrType": "cmrr",    "startDate": "string",    "endDate": "string"  }'
{  "events": [    null  ],  "totalCount": 0}

CustomerMrr

Use this when the user asks for MRR broken down per customer, or which customers contribute the most MRR. Requires permissions: subscriptions:read, customers:read.

MrrByProduct

Use this when the user asks how MRR is distributed across products or plans. Requires permissions: subscriptions:read.