Skip to main content
POST
Cancel an order

Overview

Cancel a pending order before it’s been fulfilled. Use this when a customer changes their mind, the order was created in error, or the items are no longer available.
You cannot cancel orders that have active subscriptions. If subscriptions have already been created from this order, you must cancel the subscriptions individually.

When to Use Cancellation

Request Fields

Example Request

Response Fields

What Happens

When you cancel an order:
  1. Order status changes to cancelled
  2. Order items are released (no longer reserved)
  3. Cancellation logged with reason and timestamp
  4. No subscriptions can be created from this order

Example: Cancel with Reason

Example: Check Before Cancelling

Error Handling

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Path Parameters

orderId
string
required

The order ID

Body

application/json
reason
string
Maximum string length: 1000

Response

Order cancelled

success
enum<boolean>
required
Available options:
true
message
string
required
orderId
string
required