PATCH
/
v1
/
checkout
/
sessions
/
{id}
cURL
curl --request PATCH \
  --url https://api.withflex.com/v1/checkout/sessions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "checkout_session": {
    "partner_id": "<string>",
    "status": "open",
    "payment_intent_id": "<string>",
    "invoice_id": "<string>",
    "subscription_id": "<string>",
    "customer_id": "<string>",
    "shipping_details": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "test_mode": true
  }
}'
{
  "checkout_session": {
    "allow_promotion_codes": true,
    "amount_total": 123,
    "amount_subtotal": 123,
    "cancel_url": "<string>",
    "captures": [
      {
        "amount_captured": 123,
        "capture_id": "<string>",
        "created_at": "<string>",
        "items": [
          {
            "amount_captured": 123,
            "capture_item_id": "<string>",
            "created_at": "<string>",
            "price": {
              "price_id": "<string>",
              "description": "<string>",
              "trial_period_days": 123,
              "unit_amount": 123,
              "recurring": {
                "interval": "daily",
                "interval_count": 1,
                "trial_period_days": 1
              },
              "active": true,
              "product": {
                "product_id": "<string>",
                "name": "<string>",
                "description": "<string>",
                "created_at": "<string>",
                "visit_type": "cbtSleep",
                "active": true,
                "upc_code": "<string>",
                "gtin": "<string>",
                "reference_gtin": "<string>",
                "hsa_fsa_eligibility": "not_eligible",
                "test_mode": true,
                "metadata": {}
              },
              "created_at": "<string>",
              "type": "one_time",
              "metadata": {},
              "hsa_fsa_eligibility": "not_eligible",
              "test_mode": true
            },
            "payment_intent": "<string>",
            "test_mode": true
          }
        ],
        "metadata": {},
        "test_mode": true
      }
    ],
    "capture_method": "automatic",
    "checkout_session_id": "<string>",
    "client_reference_id": "<string>",
    "created_at": 123,
    "customer": {
      "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
      "first_name": "John",
      "last_name": "Doe",
      "email": "joh.doe@example.com",
      "phone": "+15555555555",
      "employer": "Flex",
      "shipping": {
        "shipping_address_id": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "metadata": {},
      "created_at": "<string>",
      "test_mode": true
    },
    "defaults": {
      "customer_id": "<string>",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>"
    },
    "expires_at": 123,
    "invoice": "<string>",
    "hsa_fsa_eligible": true,
    "letter_of_medical_necessity_required": true,
    "metadata": {},
    "mode": "payment",
    "origin": "shopify",
    "payment_intent": {
      "payment_intent_id": "<string>",
      "amount": 123,
      "amount_capturable": 123,
      "amount_received": 123,
      "application_fee_amount": 123,
      "customer": {
        "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
        "first_name": "John",
        "last_name": "Doe",
        "email": "joh.doe@example.com",
        "phone": "+15555555555",
        "employer": "Flex",
        "shipping": {
          "shipping_address_id": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "metadata": {},
        "created_at": "<string>",
        "test_mode": true
      },
      "transfer_data": {
        "amount": 123,
        "destination": "<string>"
      },
      "status": "canceled",
      "latest_charge": "<string>",
      "created_at": "<string>",
      "invoice": {
        "invoice_id": "<string>",
        "total": 123,
        "amount_due": 123,
        "amount_paid": 123,
        "payment_intent": {},
        "charge": "<string>",
        "customer": {
          "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
          "first_name": "John",
          "last_name": "Doe",
          "email": "joh.doe@example.com",
          "phone": "+15555555555",
          "employer": "Flex",
          "shipping": {
            "shipping_address_id": "<string>",
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postal_code": "<string>",
            "country": "<string>"
          },
          "metadata": {},
          "created_at": "<string>",
          "test_mode": true
        },
        "period_end": "<string>",
        "period_start": "<string>",
        "subscription": {
          "subscription_id": "<string>",
          "created_at": "<string>",
          "items": [
            {
              "subscription_item_id": "<string>",
              "price": {
                "price_id": "<string>",
                "description": "<string>",
                "trial_period_days": 123,
                "unit_amount": 123,
                "recurring": {
                  "interval": "daily",
                  "interval_count": 1,
                  "trial_period_days": 1
                },
                "active": true,
                "product": {
                  "product_id": "<string>",
                  "name": "<string>",
                  "description": "<string>",
                  "created_at": "<string>",
                  "visit_type": "cbtSleep",
                  "active": true,
                  "upc_code": "<string>",
                  "gtin": "<string>",
                  "reference_gtin": "<string>",
                  "hsa_fsa_eligibility": "not_eligible",
                  "test_mode": true,
                  "metadata": {}
                },
                "created_at": "<string>",
                "type": "one_time",
                "metadata": {},
                "hsa_fsa_eligibility": "not_eligible",
                "test_mode": true
              },
              "quantity": 123,
              "created_at": "<string>",
              "updated_at": "<string>",
              "test_mode": true
            }
          ],
          "latest_invoice": {},
          "customer": {
            "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
            "first_name": "John",
            "last_name": "Doe",
            "email": "joh.doe@example.com",
            "phone": "+15555555555",
            "employer": "Flex",
            "shipping": {
              "shipping_address_id": "<string>",
              "line1": "<string>",
              "line2": "<string>",
              "city": "<string>",
              "state": "<string>",
              "postal_code": "<string>",
              "country": "<string>"
            },
            "metadata": {},
            "created_at": "<string>",
            "test_mode": true
          },
          "status": "incomplete",
          "cancel_at_period_end": true,
          "current_period_end": "<string>",
          "current_period_start": "<string>",
          "metadata": {},
          "test_mode": true,
          "client_secret": {
            "setup_secret": "<string>",
            "payment_secret": "<string>"
          },
          "proration_behavior": "always_invoice",
          "trial_start": "<string>",
          "trial_end": "<string>",
          "cancel_at": "<string>"
        },
        "status": "draft",
        "collection_method": "charge_automatically",
        "test_mode": true,
        "metadata": {}
      },
      "capture_method": "automatic",
      "client_secret": "<string>",
      "metadata": {},
      "payment_method": "<string>",
      "test_mode": true,
      "transfer_group": "<string>"
    },
    "redirect_url": "<string>",
    "refunds": [
      {
        "refund_id": "<string>",
        "payment_intent_id": "<string>",
        "amount": 123,
        "created_at": "<string>",
        "reason": "duplicate",
        "status": "pending",
        "test_mode": true,
        "metadata": {},
        "reference_id": "<string>",
        "reference_type": "acquirer_reference_number",
        "reference_status": "available"
      }
    ],
    "setup_intent": "<string>",
    "shipping_options": {
      "shipping_rate_id": "<string>",
      "shipping_amount": 123
    },
    "shipping_address_collection": true,
    "shipping_details": {
      "shipping_address_id": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "split_cart": {
      "split_cart_id": "<string>",
      "eligible_cart": {
        "amount_total": 123,
        "amount_subtotal": 123,
        "amount_tax": 123,
        "amount_discount": 123,
        "payment_intent": {
          "payment_intent_id": "<string>",
          "amount": 123,
          "amount_capturable": 123,
          "amount_received": 123,
          "application_fee_amount": 123,
          "customer": {
            "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
            "first_name": "John",
            "last_name": "Doe",
            "email": "joh.doe@example.com",
            "phone": "+15555555555",
            "employer": "Flex",
            "shipping": {
              "shipping_address_id": "<string>",
              "line1": "<string>",
              "line2": "<string>",
              "city": "<string>",
              "state": "<string>",
              "postal_code": "<string>",
              "country": "<string>"
            },
            "metadata": {},
            "created_at": "<string>",
            "test_mode": true
          },
          "transfer_data": {
            "amount": 123,
            "destination": "<string>"
          },
          "status": "canceled",
          "latest_charge": "<string>",
          "created_at": "<string>",
          "invoice": {
            "invoice_id": "<string>",
            "total": 123,
            "amount_due": 123,
            "amount_paid": 123,
            "payment_intent": {},
            "charge": "<string>",
            "customer": {
              "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
              "first_name": "John",
              "last_name": "Doe",
              "email": "joh.doe@example.com",
              "phone": "+15555555555",
              "employer": "Flex",
              "shipping": {
                "shipping_address_id": "<string>",
                "line1": "<string>",
                "line2": "<string>",
                "city": "<string>",
                "state": "<string>",
                "postal_code": "<string>",
                "country": "<string>"
              },
              "metadata": {},
              "created_at": "<string>",
              "test_mode": true
            },
            "period_end": "<string>",
            "period_start": "<string>",
            "subscription": {
              "subscription_id": "<string>",
              "created_at": "<string>",
              "items": [
                {
                  "subscription_item_id": "<string>",
                  "price": {
                    "price_id": "<string>",
                    "description": "<string>",
                    "trial_period_days": 123,
                    "unit_amount": 123,
                    "recurring": {
                      "interval": "daily",
                      "interval_count": 1,
                      "trial_period_days": 1
                    },
                    "active": true,
                    "product": {
                      "product_id": "<string>",
                      "name": "<string>",
                      "description": "<string>",
                      "created_at": "<string>",
                      "visit_type": "cbtSleep",
                      "active": true,
                      "upc_code": "<string>",
                      "gtin": "<string>",
                      "reference_gtin": "<string>",
                      "hsa_fsa_eligibility": "not_eligible",
                      "test_mode": true,
                      "metadata": {}
                    },
                    "created_at": "<string>",
                    "type": "one_time",
                    "metadata": {},
                    "hsa_fsa_eligibility": "not_eligible",
                    "test_mode": true
                  },
                  "quantity": 123,
                  "created_at": "<string>",
                  "updated_at": "<string>",
                  "test_mode": true
                }
              ],
              "latest_invoice": {},
              "customer": {
                "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
                "first_name": "John",
                "last_name": "Doe",
                "email": "joh.doe@example.com",
                "phone": "+15555555555",
                "employer": "Flex",
                "shipping": {
                  "shipping_address_id": "<string>",
                  "line1": "<string>",
                  "line2": "<string>",
                  "city": "<string>",
                  "state": "<string>",
                  "postal_code": "<string>",
                  "country": "<string>"
                },
                "metadata": {},
                "created_at": "<string>",
                "test_mode": true
              },
              "status": "incomplete",
              "cancel_at_period_end": true,
              "current_period_end": "<string>",
              "current_period_start": "<string>",
              "metadata": {},
              "test_mode": true,
              "client_secret": {
                "setup_secret": "<string>",
                "payment_secret": "<string>"
              },
              "proration_behavior": "always_invoice",
              "trial_start": "<string>",
              "trial_end": "<string>",
              "cancel_at": "<string>"
            },
            "status": "draft",
            "collection_method": "charge_automatically",
            "test_mode": true,
            "metadata": {}
          },
          "capture_method": "automatic",
          "client_secret": "<string>",
          "metadata": {},
          "payment_method": "<string>",
          "test_mode": true,
          "transfer_group": "<string>"
        },
        "amount_shipping": 123
      },
      "non_eligible_cart": {
        "amount_total": 123,
        "amount_subtotal": 123,
        "amount_tax": 123,
        "amount_discount": 123,
        "payment_intent": {
          "payment_intent_id": "<string>",
          "amount": 123,
          "amount_capturable": 123,
          "amount_received": 123,
          "application_fee_amount": 123,
          "customer": {
            "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
            "first_name": "John",
            "last_name": "Doe",
            "email": "joh.doe@example.com",
            "phone": "+15555555555",
            "employer": "Flex",
            "shipping": {
              "shipping_address_id": "<string>",
              "line1": "<string>",
              "line2": "<string>",
              "city": "<string>",
              "state": "<string>",
              "postal_code": "<string>",
              "country": "<string>"
            },
            "metadata": {},
            "created_at": "<string>",
            "test_mode": true
          },
          "transfer_data": {
            "amount": 123,
            "destination": "<string>"
          },
          "status": "canceled",
          "latest_charge": "<string>",
          "created_at": "<string>",
          "invoice": {
            "invoice_id": "<string>",
            "total": 123,
            "amount_due": 123,
            "amount_paid": 123,
            "payment_intent": {},
            "charge": "<string>",
            "customer": {
              "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
              "first_name": "John",
              "last_name": "Doe",
              "email": "joh.doe@example.com",
              "phone": "+15555555555",
              "employer": "Flex",
              "shipping": {
                "shipping_address_id": "<string>",
                "line1": "<string>",
                "line2": "<string>",
                "city": "<string>",
                "state": "<string>",
                "postal_code": "<string>",
                "country": "<string>"
              },
              "metadata": {},
              "created_at": "<string>",
              "test_mode": true
            },
            "period_end": "<string>",
            "period_start": "<string>",
            "subscription": {
              "subscription_id": "<string>",
              "created_at": "<string>",
              "items": [
                {
                  "subscription_item_id": "<string>",
                  "price": {
                    "price_id": "<string>",
                    "description": "<string>",
                    "trial_period_days": 123,
                    "unit_amount": 123,
                    "recurring": {
                      "interval": "daily",
                      "interval_count": 1,
                      "trial_period_days": 1
                    },
                    "active": true,
                    "product": {
                      "product_id": "<string>",
                      "name": "<string>",
                      "description": "<string>",
                      "created_at": "<string>",
                      "visit_type": "cbtSleep",
                      "active": true,
                      "upc_code": "<string>",
                      "gtin": "<string>",
                      "reference_gtin": "<string>",
                      "hsa_fsa_eligibility": "not_eligible",
                      "test_mode": true,
                      "metadata": {}
                    },
                    "created_at": "<string>",
                    "type": "one_time",
                    "metadata": {},
                    "hsa_fsa_eligibility": "not_eligible",
                    "test_mode": true
                  },
                  "quantity": 123,
                  "created_at": "<string>",
                  "updated_at": "<string>",
                  "test_mode": true
                }
              ],
              "latest_invoice": {},
              "customer": {
                "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
                "first_name": "John",
                "last_name": "Doe",
                "email": "joh.doe@example.com",
                "phone": "+15555555555",
                "employer": "Flex",
                "shipping": {
                  "shipping_address_id": "<string>",
                  "line1": "<string>",
                  "line2": "<string>",
                  "city": "<string>",
                  "state": "<string>",
                  "postal_code": "<string>",
                  "country": "<string>"
                },
                "metadata": {},
                "created_at": "<string>",
                "test_mode": true
              },
              "status": "incomplete",
              "cancel_at_period_end": true,
              "current_period_end": "<string>",
              "current_period_start": "<string>",
              "metadata": {},
              "test_mode": true,
              "client_secret": {
                "setup_secret": "<string>",
                "payment_secret": "<string>"
              },
              "proration_behavior": "always_invoice",
              "trial_start": "<string>",
              "trial_end": "<string>",
              "cancel_at": "<string>"
            },
            "status": "draft",
            "collection_method": "charge_automatically",
            "test_mode": true,
            "metadata": {}
          },
          "capture_method": "automatic",
          "client_secret": "<string>",
          "metadata": {},
          "payment_method": "<string>",
          "test_mode": true,
          "transfer_group": "<string>"
        },
        "amount_shipping": 123
      },
      "checkout_session_id": "<string>"
    },
    "status": "open",
    "success_url": "<string>",
    "fees": [],
    "subscription": {
      "subscription_id": "<string>",
      "created_at": "<string>",
      "items": [
        {
          "subscription_item_id": "<string>",
          "price": {
            "price_id": "<string>",
            "description": "<string>",
            "trial_period_days": 123,
            "unit_amount": 123,
            "recurring": {
              "interval": "daily",
              "interval_count": 1,
              "trial_period_days": 1
            },
            "active": true,
            "product": {
              "product_id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "created_at": "<string>",
              "visit_type": "cbtSleep",
              "active": true,
              "upc_code": "<string>",
              "gtin": "<string>",
              "reference_gtin": "<string>",
              "hsa_fsa_eligibility": "not_eligible",
              "test_mode": true,
              "metadata": {}
            },
            "created_at": "<string>",
            "type": "one_time",
            "metadata": {},
            "hsa_fsa_eligibility": "not_eligible",
            "test_mode": true
          },
          "quantity": 123,
          "created_at": "<string>",
          "updated_at": "<string>",
          "test_mode": true
        }
      ],
      "latest_invoice": {},
      "customer": {
        "customer_id": "fcus_01HACM7FZ1084XB1GB6053VM0D",
        "first_name": "John",
        "last_name": "Doe",
        "email": "joh.doe@example.com",
        "phone": "+15555555555",
        "employer": "Flex",
        "shipping": {
          "shipping_address_id": "<string>",
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        },
        "metadata": {},
        "created_at": "<string>",
        "test_mode": true
      },
      "status": "incomplete",
      "cancel_at_period_end": true,
      "current_period_end": "<string>",
      "current_period_start": "<string>",
      "metadata": {},
      "test_mode": true,
      "client_secret": {
        "setup_secret": "<string>",
        "payment_secret": "<string>"
      },
      "proration_behavior": "always_invoice",
      "trial_start": "<string>",
      "trial_end": "<string>",
      "cancel_at": "<string>"
    },
    "subscription_data": {
      "cancel_at": "<string>",
      "trial_end": "<string>",
      "cancel_at_period_end": true,
      "trial_period_days": 123
    },
    "tax_rate": {
      "amount": 123
    },
    "tax_calculation_mode": "exclusive",
    "test_mode": true,
    "total_details": {
      "amount_discount": 123,
      "amount_tax": 123,
      "amount_shipping": 123,
      "amount_iias": 123,
      "amount_vision": 123,
      "amount_prescription": 123,
      "amount_service": 123,
      "amount_fee": 123
    },
    "visit_type": "cbtSleep",
    "setup_future_use": "<any>"
  }
}

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Body

application/json

Response

200 - application/json

The response is of type object.