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…
Authentication
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.
companyId*stringuuidapplication/json- body
customerId*string1 <= lengthname?string|nullcurrency*string1 <= lengthexternalId?string|nullCreated subscription
application/json- response
id*stringuuidcompanyId*stringuuidcustomerId*stringThe ID of the customer this subscription belongs to.
uuidexternalId*|External subscription ID (e.g., Stripe subscription ID).
name*|The name of the subscription.
currency*stringThe currency of the subscription.
"EUR""AUD""BRL""CAD""CHF""CNY""CZK""DKK""GBP""HKD""HUF""IDR""ILS""INR""ISK""JPY""KRW""MXN""MYR""NOK""NZD""PHP""PLN""RON""SEK""SGD""THB""TRY""USD""ZAR"replacedBySubscriptionId*|The ID of the subscription that continued this one, for a plan change that was modeled as a new subscription. MRR reports then show the switch as one upgrade or downgrade by the difference, instead of a cancellation of this subscription and a new one. Null if not replaced.
uuidcreatedTime*|date-timecreatedUserId*string|nulllastUpdatedTime*|date-timelastUpdatedUserId*string|nullcurl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/subscriptions' \ -H 'Content-Type: application/json' \ -d '{ "customerId": "string", "currency": "string"}'{ "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"}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.
Retrieve subscription
Retrieve a single subscription by id. Returns 404 if the subscription does not exist or belongs to another company.