curl --request GET \
--url https://api.withflex.com/v1/checkout/sessions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.withflex.com/v1/checkout/sessions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.withflex.com/v1/checkout/sessions', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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"
req, _ := http.NewRequest("GET", 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.get("https://api.withflex.com/v1/checkout/sessions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withflex.com/v1/checkout/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"checkout_sessions": [
{
"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",
"payment_intents": [
"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",
"applied": true,
"waived_reason": "existing_letter"
}
],
"custom_text": {
"after_submit": {
"message": "Premium SPF 50 mineral sunscreen"
},
"shipping_address": {
"message": "Premium SPF 50 mineral sunscreen"
},
"submit": {
"message": "Premium SPF 50 mineral sunscreen"
},
"terms_of_service_acceptance": {
"message": "Premium SPF 50 mineral sunscreen"
},
"terms_of_service_checkbox_required": true,
"payment": {
"message": "Premium SPF 50 mineral sunscreen"
}
},
"subscription": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"subscription_data": {
"cancel_at": "2026-06-15T14:30:00Z",
"trial_end": "string",
"cancel_at_period_end": false,
"trial_period_days": 0,
"trial_settings": {
"end_behavior": {
"missing_payment_method": "cancel"
}
}
},
"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": {
"discounts": [
{
"discount": {
"discount_id": "fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"checkout_session": "fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"customer": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"subscription": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"invoice": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"source": {
"coupon": "fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"type": "coupon"
},
"promo_code": "fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"test_mode": false,
"end": "string",
"start": "string"
}
}
]
}
},
"visit_type": "cbtSleep",
"setup_future_use": "on_session",
"payment_method_options": {
"card": {
"request_three_d_secure": "automatic"
}
},
"next_action": {
"type": "collect_letter_of_medical_necessity",
"collect_letter_of_medical_necessity": {
"url": "https://example.com"
},
"payment_failed": {
"message": "Premium SPF 50 mineral sunscreen",
"url": "https://example.com",
"decline_code": "string",
"error_code": "string"
},
"provide_second_payment_method": {
"message": "Premium SPF 50 mineral sunscreen",
"url": "https://example.com",
"eligible_amount": 0,
"ineligible_amount": 0
},
"provide_alternative_payment_method": {
"message": "Premium SPF 50 mineral sunscreen",
"url": "https://example.com"
}
},
"partner": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"platform_fees": {
"letter_fee": {
"amount": 2500,
"type": "string",
"status": "pending"
}
}
}
]
}{
"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"
}List Checkout Sessions
Returns a list of your Checkout Sessions, most recent first.
curl --request GET \
--url https://api.withflex.com/v1/checkout/sessions \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.withflex.com/v1/checkout/sessions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.withflex.com/v1/checkout/sessions', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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"
req, _ := http.NewRequest("GET", 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.get("https://api.withflex.com/v1/checkout/sessions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withflex.com/v1/checkout/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"checkout_sessions": [
{
"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",
"payment_intents": [
"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",
"applied": true,
"waived_reason": "existing_letter"
}
],
"custom_text": {
"after_submit": {
"message": "Premium SPF 50 mineral sunscreen"
},
"shipping_address": {
"message": "Premium SPF 50 mineral sunscreen"
},
"submit": {
"message": "Premium SPF 50 mineral sunscreen"
},
"terms_of_service_acceptance": {
"message": "Premium SPF 50 mineral sunscreen"
},
"terms_of_service_checkbox_required": true,
"payment": {
"message": "Premium SPF 50 mineral sunscreen"
}
},
"subscription": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"subscription_data": {
"cancel_at": "2026-06-15T14:30:00Z",
"trial_end": "string",
"cancel_at_period_end": false,
"trial_period_days": 0,
"trial_settings": {
"end_behavior": {
"missing_payment_method": "cancel"
}
}
},
"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": {
"discounts": [
{
"discount": {
"discount_id": "fdi_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"checkout_session": "fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"customer": "fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"subscription": "fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"invoice": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"source": {
"coupon": "fcoup_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"type": "coupon"
},
"promo_code": "fpromo_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"test_mode": false,
"end": "string",
"start": "string"
}
}
]
}
},
"visit_type": "cbtSleep",
"setup_future_use": "on_session",
"payment_method_options": {
"card": {
"request_three_d_secure": "automatic"
}
},
"next_action": {
"type": "collect_letter_of_medical_necessity",
"collect_letter_of_medical_necessity": {
"url": "https://example.com"
},
"payment_failed": {
"message": "Premium SPF 50 mineral sunscreen",
"url": "https://example.com",
"decline_code": "string",
"error_code": "string"
},
"provide_second_payment_method": {
"message": "Premium SPF 50 mineral sunscreen",
"url": "https://example.com",
"eligible_amount": 0,
"ineligible_amount": 0
},
"provide_alternative_payment_method": {
"message": "Premium SPF 50 mineral sunscreen",
"url": "https://example.com"
}
},
"partner": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"platform_fees": {
"letter_fee": {
"amount": 2500,
"type": "string",
"status": "pending"
}
}
}
]
}{
"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
Use a Bearer token to access this API.
Query Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
1 <= x <= 900719925474099110
Number of objects to skip before returning results.
-9007199254740991 <= x <= 90071992547409913
Filter by time interval in days (e.g., 30 for last 30 days).
-2147483648 <= x <= 21474836472500
Filter by payment intent ID.
"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Filter by checkout session status.
open, paid, complete, canceled, expired "open"
Filter by customer ID.
"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Filter results by customer email address.
"john.doe@example.com"
Filter by subscription ID.
"fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Filter by the client reference ID you provided when creating the checkout session.
"example_value"
If true, expands the customer object in the response.
false
If true, expands the payment intent object in the response.
false
Comma-separated list of related objects to expand in the response.
""
Return sessions created after this timestamp (exclusive). ISO 8601 format.
"2026-06-15T14:30:00Z"
Return sessions created at or after this timestamp (inclusive). ISO 8601 format.
"2026-06-15T14:30:00Z"
Return sessions created before this timestamp (exclusive). ISO 8601 format.
"2026-06-15T14:30:00Z"
Return sessions created at or before this timestamp (inclusive). ISO 8601 format.
"2026-06-15T14:30:00Z"
A cursor for use in pagination. starting_after is a checkout session ID that defines your place in the list. For instance, if you make a list request and receive 20 checkout sessions, ending with fcs_xyz, your subsequent call can include starting_after=fcs_xyz to fetch the next page.
"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
A cursor for use in pagination. ending_before is a checkout session ID that defines your place in the list. For instance, if you make a list request and receive 20 checkout sessions, starting with fcs_abc, your subsequent call can include ending_before=fcs_abc to fetch the previous page.
"fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
Return only checkout sessions with any associated dispute
false
Filter by checkout session mode.
payment, subscription, off_session, setup "payment"
Response
An envelope wrapping a list of checkout session objects.
An envelope wrapping a list of checkout session objects.
The list of checkout sessions.
Show child attributes
Show child attributes