SaaSFlow
DevelopersAPIReferencesubscriptions

List subscriptions

List subscriptions, optionally narrowed to one customer with customerId or to the subscriptions that ever booked an event against a product with productId.

Authentication

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

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

Query Parameters

customerId?string
Formatuuid
productId?string
Formatuuid

Response Body

application/json

curl -X GET "https://example.com/companies/string/subscriptions"
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "externalId": "string",    "name": "string",    "currency": "EUR",    "replacedBySubscriptionId": "91638c4c-42cb-4ba3-a36c-8035f4ae68e4",    "createdTime": "2019-08-24T14:15:22Z",    "createdUserId": "string",    "lastUpdatedTime": "2019-08-24T14:15:22Z",    "lastUpdatedUserId": "string",    "customerName": "string"  }]

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.

Create subscription

Create a subscription for a customer. Creating one on its own contributes nothing to MRR: add subscription events to it, starting with a new event, for the…