Update subscription event
Correct a subscription event. Only the fields you send change. Because events are deltas, editing one rewrites MRR from its `effectiveTime` onward, so a correction here moves historical numbers rather than only affecting the present. Events mirrored from a billing provider are overwritten on the next sync; fix those at the source.
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 <= length1 <= lengthRequest 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/subscription_events/string" \ -H "Content-Type: application/json" \ -d '{}'{ "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"}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 permanently over- or under-counted. To end a subscription, add a cancelling event rather than deleting the ones that created it.
List planned transactions
List planned transactions for a company. Each row is a recurrence rule, not a dated event. For individual dated occurrences, and for totals over a date range, use the `planned_transaction_occurrences` endpoint instead. Amount semantics: `amountValue` is the **net** amount excluding pass-through taxes (e.g. VAT). When `passThroughTaxAmount` is non-null, the **gross cash impact** on the bank account is `amountValue + passThroughTaxAmount`. For "planned cash inflow / outflow" questions, sum the gross amount; for "planned revenue / cost net of VAT", sum `amountValue` only.