SaaSFlow
DevelopersAPIReferencesubscription_events

Create subscription event

Create a subscription event with the SaaSFlow REST API. Request parameters, response fields, and an interactive playground.

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
POST
/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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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"}
{  "error": "string"}

List subscription events

List a company's subscription events with the SaaSFlow REST API. Request parameters, response fields, and an interactive playground.

Delete subscription event

Delete a subscription event with the SaaSFlow REST API. Request parameters, response fields, and an interactive playground.