SaaSFlow
DevelopersAPIReferenceproduct_groups

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.

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/product_groups

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

Response Body

application/json

curl -X GET "https://example.com/companies/string/product_groups"
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",    "name": "string",    "archived": true,    "order": -8388608,    "createdTime": "2019-08-24T14:15:22Z",    "createdUserId": "string",    "lastUpdatedTime": "2019-08-24T14:15:22Z",    "lastUpdatedUserId": "string"  }]

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…

Create product group

Create a product group. order is required and sets the position in the list; pass a number higher than every existing group to append at the end.