MrrData

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

Authentication

Checking whether you're signed in…

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.

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}

timeZone?string

IANA time zone. Defaults to BatchContext.timeZone, then UTC.

filterCustomerIds?array<string>

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

`application/json`

curl -X POST "https://example.com/companies/string/data/mrrData" \  -H "Content-Type: application/json" \  -d '{    "mrrType": "cmrr"  }'

[  [    "string",    {      "mrr": 0,      "customerCount": 0    }  ]]

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

403application/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`