SaaSFlow
DevelopersAPIReferenceproducts

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.

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.
GET
/companies/{companyId}/products

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/products"
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",    "name": "string",    "productGroupId": "c416ccc2-c7d5-4733-9136-58a3b93937ed",    "order": -8388608,    "createdTime": "2019-08-24T14:15:22Z",    "createdUserId": "string",    "lastUpdatedTime": "2019-08-24T14:15:22Z",    "lastUpdatedUserId": "string",    "externalIds": [      "string"    ],    "eventCount": 0,    "cmrrByCurrency": {      "property1": 0,      "property2": 0    }  }]

Update product group

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

Create product

Create a product. Pass `productGroupId` to file it under a group straight away, or leave it null or absent for an ungrouped product. Fails with 404 if the named group does not exist. Products imported from a billing provider are created by the importer, so create by hand only for revenue you track yourself.