SaaSFlow
DevelopersAPIReferencesubscription_events

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…

Authentication

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

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
subscriptionId*string
Length1 <= length
productId*string
Length1 <= length
committedTime*string
Length1 <= length
effectiveTime*string
Length1 <= length
mrrChange*string
quantityChange*number
billingInterval*string
Length1 <= length
billingIntervalCount*integer

Response Body

Created subscription event

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
subscriptionId*string
Formatuuid
productId*string
Formatuuid
committedTime*string

When the subscription change was committed.

Formatdate-time
effectiveTime*string

When the subscription change takes effect.

Formatdate-time
mrrChange*string

The change in monthly recurring revenue.

quantityChange*number

The change in quantity (non-monetary).

Range-8388608 <= value <= 8388607
billingInterval*string

The billing interval (day, week, month, year).

Value in"day""week""month""year"
billingIntervalCount*integer

The number of billing intervals per cycle.

Range-2147483648 <= value <= 2147483647
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
curl -X POST "https://example.com/companies/string/subscription_events" \  -H "Content-Type: application/json" \  -d '{    "subscriptionId": "string",    "productId": "string",    "committedTime": "string",    "effectiveTime": "string",    "mrrChange": "string",    "quantityChange": 0,    "billingInterval": "string",    "billingIntervalCount": 0  }'
{  "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"}

List subscription events

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

Delete subscription event

Delete a subscription event. Its mrrChange is removed from every period after its effectiveTime, so deleting the wrong row leaves a subscription…