CustomerChanges
Use this when the user asks which customers changed (new/upgraded/downgraded/churned) in a period. Requires permissions: subscriptions:read, customers:read.
Authentication
sf_… API key in the bearerAuth field below.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
1 <= lengthRequest 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/customerChanges" \ -H "Content-Type: application/json" \ -d '{ "mrrType": "cmrr", "startDate": "string", "endDate": "string" }'[ null]CustomerMonthlyData
Use this when the user asks for one customer's month-by-month metrics or activity. For per-customer MRR in a month, request dataType "end" (MRR at month end). Requires permissions: subscriptions:read, customers:read.
RetentionCohortDetail
Use this when the user asks for the customer-level detail behind a specific retention cohort cell. Requires permissions: subscriptions:read, customers:read.