Skip to main content
POST
Calculate early return fee

Overview

Calculate the early return fee for a subscription before processing the actual early return. This endpoint returns a recommended fee based on remaining contract value and your configured policies—use it to present options to customers.
This is a read-only calculation—it doesn’t modify the subscription. Call Early Return to actually process the return.

Request Fields

Example Request

Response Structure

Understanding the Calculation

Remaining Contract Value

Total value of remaining payments:

Fee Percentage

The percentage of remaining value charged as fee (configured in tenant settings):

Cost Recovery Impact

The calculation shows whether you’ll recover costs even with early return:
  • projectedWithFee: Total collected + early return fee
  • costRecoveryPercent: Whether acquisition cost is covered

Common Use Cases

1. Quoting Customers

2. Comparing Options for Customer

3. Evaluating Fee Waiver

Presentation Tips

When showing early return fees to customers:
  • Compare to remaining payments: Show savings vs completing contract
  • Explain the policy: Help customers understand the fee rationale
  • Offer alternatives: Present buyout or extension options
  • Be flexible: Consider waivers for good customers or hardship cases

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Body

application/json
rentalId
string
required

The subscription ID

Response

Early return fee calculation

success
enum<boolean>
required
Available options:
true
earlyReturnFee
number
required
remainingMonths
number
required
penaltyPercentage
number
required