Skip to main content
POST
/
v1
/
subscriptions
/
{subscriptionId}
/
upgrade
Upgrade a subscription
curl --request POST \
  --url https://api-eu.flexportal.io/v1/subscriptions/{subscriptionId}/upgrade \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-ID: <tenant-id>' \
  --data '
{
  "tenantId": "<string>",
  "rentalId": "<string>",
  "newSku": "<string>",
  "newSerialNumber": "<string>",
  "contractLength": 60,
  "newMonthlyAmount": 1,
  "reason": "<string>",
  "notes": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "oldRentalId": "<string>",
  "newRentalId": "<string>",
  "oldDevice": "<string>",
  "newDevice": "<string>",
  "newMonthlyAmount": 1,
  "currency": "<string>"
}

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Path Parameters

subscriptionId
string
required

The subscription ID

Body

application/json
tenantId
string
required
Minimum string length: 1
rentalId
string
required
Minimum string length: 1
newSku
string
required
Minimum string length: 1
newSerialNumber
string
required
Minimum string length: 1
contractLength
integer
required
Required range: 1 < x <= 120
newMonthlyAmount
number
required
Required range: x >= 0
reason
string
required
Minimum string length: 1
notes
string

Response

Upgrade completed

success
enum<boolean>
required
Available options:
true,
false
message
string
required
oldRentalId
string
required
newRentalId
string
required
oldDevice
string
required
newDevice
string
required
newMonthlyAmount
number
required
Required range: x >= 0
currency
string
required