Update subscription

Update a subscription. Only the fields you send change. This edits the container only, never the revenue: to change what a subscription is worth, add or…

Authentication

Checking whether you're signed in…

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

subscriptionId*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string|null

currency?string

Length1 <= length

replacedBySubscriptionId?|

Mark this subscription as replaced by another subscription of the same customer and currency that started later, for a plan change that was modeled as a new subscription. MRR reports then show one upgrade or downgrade by the difference at the new start. Send null to remove the link.

Formatuuid

Response Body

`application/json`

curl -X PUT "https://example.com/companies/string/subscriptions/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "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"}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

404application/json

409application/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`