Skip to main content
POST
/
v1
/
checkout
/
sessions
/
{id}
/
cancel
Cancel Auth Checkout Session
curl --request POST \
  --url https://api.withflex.com/v1/checkout/sessions/{id}/cancel \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.withflex.com/v1/checkout/sessions/{id}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.withflex.com/v1/checkout/sessions/{id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.withflex.com/v1/checkout/sessions/{id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.withflex.com/v1/checkout/sessions/{id}/cancel"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.withflex.com/v1/checkout/sessions/{id}/cancel")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.withflex.com/v1/checkout/sessions/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "checkout_session": {
    "allow_promotion_codes": false,
    "amount_total": 2500,
    "amount_subtotal": 2500,
    "amount_received": 2500,
    "amount_refunded": 2500,
    "amount_disputed": 2500,
    "cancel_url": "https://example.com",
    "captures": [],
    "disputes": [],
    "capture_method": "automatic",
    "checkout_session_id": "fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "client_reference_id": "example_value",
    "created_at": 2500,
    "defaults": {},
    "expires_at": 2500,
    "invoice": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "hsa_fsa_eligible": false,
    "letter_of_medical_necessity_required": false,
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "mode": "payment",
    "origin": "shopify",
    "redirect_url": "https://example.com",
    "refunds": [],
    "setup_intent": "fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "shipping_options": {},
    "shipping_address_collection": false,
    "shipping_details": {},
    "status": "open",
    "success_url": "https://example.com",
    "fees": [
      {}
    ],
    "custom_text": {},
    "subscription_data": {},
    "tax_rate": {},
    "tax_calculation_mode": "exclusive",
    "test_mode": false,
    "total_details": {
      "amount_discount": 2500,
      "amount_tax": 2500,
      "amount_shipping": 2500,
      "amount_iias": 2500,
      "amount_vision": 2500,
      "amount_prescription": 2500,
      "amount_service": 2500,
      "amount_fee": 2500
    },
    "visit_type": "cbtSleep",
    "setup_future_use": "on_session",
    "payment_method_options": {},
    "platform_fees": {}
  }
}
{
"code": "string",
"detail": "string"
}
{
"code": "string",
"detail": "string"
}
{
"code": "string",
"detail": "string"
}
{
"code": "string",
"detail": "string"
}
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}
{
"code": "string",
"detail": "string"
}

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Path Parameters

id
string
required
Example:

"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

Query Parameters

expand
string
default:""

Comma-separated list of related objects to expand in the response.

Example:

""

Response

Success

An envelope wrapping a single checkout session object.

checkout_session
object
required

The checkout session payload.

Example:
{
"allow_promotion_codes": false,
"amount_total": 2500,
"amount_subtotal": 2500,
"amount_received": 2500,
"amount_refunded": 2500,
"amount_disputed": 2500,
"cancel_url": "https://example.com",
"captures": ["fcap_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],
"disputes": ["fdp_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],
"capture_method": "automatic",
"checkout_session_id": "fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"client_reference_id": "example_value",
"created_at": 2500,
"customer": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"defaults": {
"customer_id": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "+14155550142"
},
"expires_at": 2500,
"invoice": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"hsa_fsa_eligible": false,
"letter_of_medical_necessity_required": false,
"metadata": { "order_id": "8842", "channel": "shopify" },
"mode": "payment",
"origin": "shopify",
"payment_intent": "fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"redirect_url": "https://example.com",
"refunds": ["fre_01J9XR8M3K7VZ8N2YB4WJ6T0RA"],
"setup_intent": "fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"shipping_options": {
"shipping_rate_id": "fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"shipping_amount": 2500,
"display_name": "Example"
},
"shipping_address_collection": false,
"shipping_details": {
"shipping_address_id": "fsh_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"line1": "123 Main St",
"line2": "Suite 100",
"city": "San Francisco",
"state": "CA",
"postal_code": "94107",
"country": "US"
},
"split_cart": "fsplit_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"status": "open",
"success_url": "https://example.com",
"fees": [
{
"fee_id": "ffee_1234567890",
"amount": 2500,
"name": "Example",
"description": "Premium SPF 50 mineral sunscreen",
"fee_type": "lmn_consultation"
}
],
"custom_text": {},
"subscription": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"subscription_data": {
"cancel_at": "2026-06-15T14:30:00Z",
"cancel_at_period_end": false
},
"tax_rate": { "amount": 2500 },
"tax_calculation_mode": "exclusive",
"test_mode": false,
"total_details": {
"amount_discount": 2500,
"amount_tax": 2500,
"amount_shipping": 2500,
"amount_iias": 2500,
"amount_vision": 2500,
"amount_prescription": 2500,
"amount_service": 2500,
"amount_fee": 2500,
"breakdown": {}
},
"visit_type": "cbtSleep",
"setup_future_use": "on_session",
"payment_method_options": {},
"next_action": {
"type": "collect_letter_of_medical_necessity"
},
"partner": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"platform_fees": { "letter_fee": {} }
}