SaaSFlow
DevelopersAPIReferenceproduct_groups

Update product group

Rename a product group or archive it. Archiving hides the group without changing the products assigned to it.

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}/product_groups/{productGroupId}

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
productGroupId*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/product_groups/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}

Delete product group

Delete a product group. Move every product out of the group first (`PUT /products/{productId}/change_group`), otherwise the delete fails on the foreign key from products. Archive the group with `PUT` if you only want it hidden.

List products

List a company's products, each with `eventCount` (how many subscription events reference it) and `cmrrByCurrency` (current committed MRR keyed by currency code, unconverted). Products are the plans and add-ons that subscription events are booked against, which is what makes revenue breakdowns by product possible. `productGroupId` is null for products that sit outside any group.