Skip to main content
POST
Cancel a subscription

Overview

Cancel an active subscription. Use this when a customer wants to terminate their subscription without going through the normal end-of-contract flow. Unlike early return, cancellation doesn’t immediately trigger a device return.

When to Use Cancellation

Request Fields

Reason Options

Example Request

What Happens

When you cancel a subscription:
  1. Subscription status changes to cancelled
  2. Future payments are voided
  3. Asset marked for return collection
  4. Cancellation logged with reason and timestamp

Response Fields

Example: Cancel with Payment Failure

Example: Customer-Initiated Cancellation

Cancellation vs Early Return

Error Handling

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
rentalId
string
required
Minimum string length: 1
reason
enum<string>
required
Available options:
customer_request,
payment_failure,
fraud,
admin_decision,
other
notes
string
Maximum string length: 1000

Response

Subscription cancelled

success
enum<boolean>
required
Available options:
true
rentalId
string
required
assetSerialNumber
string
required
previousStatus
enum<string>
required
Available options:
active
cancelledAt
string
required
message
string
required