SaaSFlow
DevelopersAPIReferencesubscription_events

List subscription events

List subscription events, optionally narrowed by subscriptionId, customerId or productId. These events are the ledger SaaSFlow computes MRR from.

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/subscription_events

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

Query Parameters

subscriptionId?string
customerId?string
productId?string

Response Body

application/json

curl -X GET "https://example.com/companies/string/subscription_events"
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",    "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",    "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",    "committedTime": "2019-08-24T14:15:22Z",    "effectiveTime": "2019-08-24T14:15:22Z",    "mrrChange": "string",    "quantityChange": -8388608,    "billingInterval": "day",    "billingIntervalCount": -2147483648,    "createdTime": "2019-08-24T14:15:22Z",    "createdUserId": "string",    "lastUpdatedTime": "2019-08-24T14:15:22Z",    "lastUpdatedUserId": "string"  }]

Update subscription

Update a subscription. Only the fields you send change. This edits the container only, never the revenue: to change what a subscription is worth, add or…

Create subscription event

Record a subscription event, which is how revenue actually enters SaaSFlow. mrrChange is a signed delta in the subscription's currency, sent as a decimal…