SaaSFlow
DevelopersAPIReferenceproducts

Update external id

Replace a product's external ids with the list you send. This is a full replacement, not a merge, so include the ids you want to keep. An id already claimed by a different product in the same company is refused with 409, which stops one billing plan mapping to two products.

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}/products/{productId}/external-ids

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
productId*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/products/string/external-ids" \  -H "Content-Type: application/json" \  -d '{    "externalIds": [      "string"    ]  }'
{  "externalIds": [    "string"  ]}

List external ids

List the external ids linked to a product. These map the product to its counterpart in a billing system (a Stripe price or product id, for instance), which is how imported subscription events find the right product.

List subscriptions

List subscriptions, optionally narrowed to one customer with `customerId`. A subscription here is a container with a customer and a currency; the money lives in its subscription events, which record every new, upgrade, downgrade, cancel, and reactivate. To see what a subscription is currently worth, read its events rather than the subscription row. Subscriptions with a non-null `externalId` are mirrored from a billing provider and should be changed there, not here.