Skip to main content
POST
/
v1
/
subscriptions
/
{subscriptionId}
/
early-return
Early return a subscription
curl --request POST \
  --url https://api-eu.flexportal.io/v1/subscriptions/{subscriptionId}/early-return \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-ID: <tenant-id>' \
  --data '
{
  "tenantId": "<string>",
  "rentalId": "<string>",
  "returnCondition": "excellent",
  "reason": "<string>",
  "earlyReturnFee": 1,
  "damageAssessment": "<string>",
  "notes": "<string>"
}
'
{
  "success": true,
  "rentalId": "<string>",
  "assetSerialNumber": "<string>",
  "earlyReturnFee": 1,
  "currency": "<string>",
  "actualMonthsRented": 60,
  "returnDate": "<string>",
  "message": "<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
​
returnCondition
enum<string>
required
Available options:
excellent,
good,
fair,
poor,
damaged
​
reason
string
required
Minimum string length: 1
​
earlyReturnFee
number
Required range: x >= 0
​
damageAssessment
string
​
notes
string

Response

Early return completed

​
success
boolean
required
​
rentalId
string
required
​
assetSerialNumber
string
required
​
earlyReturnFee
number
required
Required range: x >= 0
​
currency
string
required
​
actualMonthsRented
integer
required
Required range: 0 <= x <= 120
​
returnDate
string
required
​
message
string
required