SaaSFlow
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
/companies/{companyId}/data/customerMrr

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/customerMrr" \  -H "Content-Type: application/json" \  -d '{    "mrrType": "cmrr",    "date": "string"  }'
{  "customers": [    {      "customerId": "string",      "value": 0,      "customer": {        "name": "string",        "countryCode": "string",        "logoUrl": "string"      }    }  ],  "totalCount": 0}

MonthlyData

Use this when the user asks for month-by-month revenue, churn, new/upgrade/downgrade breakdowns, or movement summaries.

MrrChangeEvents

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