SaaSFlow
DevelopersAPIReferencedata

MonthlyData

Use this when the user asks for month-by-month revenue, churn, new/upgrade/downgrade breakdowns, or movement summaries. 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/monthlyData

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/monthlyData" \  -H "Content-Type: application/json" \  -d '{    "mrrType": "cmrr"  }'
[  {    "month": "string",    "start": 0,    "startCount": 0,    "new": 0,    "newCount": 0,    "reactivate": 0,    "reactivateCount": 0,    "upgrade": 0,    "upgradeCount": 0,    "downgrade": 0,    "downgradeCount": 0,    "cancel": 0,    "cancelCount": 0,    "currency": 0,    "currencyCount": 0,    "end": 0,    "endCount": 0  }]

MrrData

Use this when the user asks how MRR has changed over time, MRR trend, or monthly recurring revenue history. Requires permissions: subscriptions:read.

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.