SaaSFlow
DevelopersAPIReferencesubscriptions

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 edit its subscription events.

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.
PUT
/companies/{companyId}/subscriptions/{subscriptionId}

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
subscriptionId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://example.com/companies/string/subscriptions/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",  "externalId": "string",  "name": "string",  "currency": "EUR",  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Delete subscription

Delete a subscription and its events, which removes its contribution from MRR history for every period it covered. Subscriptions with an `externalId` are mirrored from a billing provider and refuse deletion with 400; cancel them at the source so the next sync reflects it. To end a subscription without erasing its history, record a `cancel` event instead.

List subscription events

List subscription events, optionally narrowed by `subscriptionId` or `customerId`. These events are the ledger SaaSFlow computes MRR from. Each row is a **delta**, not a level: `mrrChange` is the amount added or removed at that moment, so a subscription's current MRR is the sum of its events, and a plain cancellation shows up as a negative `mrrChange` that offsets what came before. Two timestamps matter and they are not interchangeable: `effectiveTime` is when the change hits MRR, `committedTime` is when it was agreed, which is what committed MRR is measured on. Amounts are in the parent subscription's currency.