SaaSFlow
DevelopersAPIReferenceplan_items

Update plan item

Update a plan item. Only the fields you send are changed. Switching the `amount` rule to a different shape means sending the whole `amount` object, not just the field you want to change.

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}/plan_items/{planItemId}

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
planItemId*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/plan_items/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "month": "string",  "plType": "revenue",  "categoryId": "string",  "amount": {    "type": "fixed",    "amount": {      "value": 0,      "currency": "EUR"    },    "relativeChange": 0  },  "duration": -2147483648,  "frequency": -2147483648,  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Delete plan item

Delete a plan item, removing it from every month it covered. Deletion is not blocked by other plan items whose `reference` rule points at this item's category, so check those before removing a line other plan items are derived from.

List product groups

List a company's product groups. Product groups bundle related products so revenue reporting can roll up by group instead of by individual product. Archived groups are included; filter on `archived` for the active ones. Results come back unsorted, so sort by `order` ascending to match the app.