SaaSFlow
DevelopersAPIReferenceplan_items

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…

Authentication

Checking whether you're signed in…
DELETE
/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

Response Body

Plan item deleted

application/json
  1. response
success*boolean
curl -X DELETE "https://example.com/companies/string/plan_items/string"
{  "success": true}

Retrieve plan item

Retrieve a single plan item by id. Returns 404 if the item does not exist or belongs to another company.

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…