SaaSFlow
DevelopersAPIReferencedata

MrrAtDate

Use this when the user asks for total MRR (or committed MRR) on a specific date. Requires permissions: subscriptions:read.

Authentication

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

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
Length1 <= length

Request Body

application/json
  1. body
mrrType*string

MRR variant. cmrr = committed MRR (CMRR), mrr = recognised MRR.

Value in"cmrr""mrr"
date*string

Snapshot date (YYYY-MM-DD).

Match^\d{4}-\d{2}-\d{2}
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

mrrAtDate result

application/json
  1. response
mrr*number
customerCount*number
curl -X POST "https://example.com/companies/string/data/mrrAtDate" \  -H "Content-Type: application/json" \  -d '{    "mrrType": "cmrr",    "date": "string"  }'
{  "mrr": 0,  "customerCount": 0}

Batch

Run several analytics slices in one round trip. Each entry in slices is a descriptor { type, _id?, ...params } where type names the slice and the rest are…

MrrData

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