Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Checkout Sessions

Get Checkout Session

Retrieves the Checkout Session with the given ID. Use the expand parameters to inline related objects such as the customer, payment intent, or subscription in the response.

get/v1/checkout/sessions/{id}

Path parameters

idstring required
Example:fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Query parameters

expand_customerboolean nullable

If true, expands the customer object in the response.

If true, expands the customer object in the response.

expand_payment_intentboolean nullable

If true, expands the payment intent object in the response.

If true, expands the payment intent object in the response.

expand_subscriptionboolean nullable

If true, expands the subscription object in the response.

If true, expands the subscription object in the response.

expandstring

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

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

Response

An envelope wrapping a single checkout session object.

Example response

{
  "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": {}
  }
}