Skip to main content
POST
/
v1
/
subscriptions
/
{subscriptionId}
/
replace
Replace subscription device
curl --request POST \
  --url https://api-eu.flexportal.io/v1/subscriptions/{subscriptionId}/replace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-ID: <tenant-id>' \
  --data '
{
  "tenantId": "<string>",
  "rentalId": "<string>",
  "newSerialNumber": "<string>",
  "replacementReason": "damaged",
  "newSku": "<string>",
  "damageAssessment": "<string>",
  "insuranceClaim": false,
  "notes": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "rentalId": "<string>",
  "oldSerialNumber": "<string>",
  "newSerialNumber": "<string>",
  "reason": "<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
newSerialNumber
string
required
Minimum string length: 1
replacementReason
enum<string>
required
Available options:
damaged,
stolen,
defective,
lost
newSku
string
damageAssessment
string
insuranceClaim
boolean
default:false
notes
string

Response

Device replaced

success
enum<boolean>
required
Available options:
true,
false
message
string
required
rentalId
string
required
oldSerialNumber
string
required
newSerialNumber
string
required
reason
string
required