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…

Authentication

Checking whether you're signed in…
PUT
/companies/{companyId}/plan_items/{planItemId}

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

Request Body

application/json
  1. body
month?string
Length1 <= length
plType?string
Length1 <= length
categoryId?string
Length1 <= length
amount?||
duration?integer|null
frequency?integer

Response Body

Updated plan item

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
month*string

The month this plan item applies to (YYYY-MM format).

plType*string

The P&L type of the item.

Value in"revenue""cogs""cac""pd""ga""no""neutral"
categoryId*string

The category ID for this plan item.

amount*||

The amount configuration (fixed, average, or reference).

duration*|

Duration in months. Null for indefinite.

Range-2147483648 <= value <= 2147483647
frequency*integer

How often the item recurs.

Range-2147483648 <= value <= 2147483647
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
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…

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.