v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB

Checkout Sessions

List Checkout Sessions

Returns a list of your Checkout Sessions, most recent first.

get/v1/checkout/sessions

Query parameters

limitinteger nullable

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

offsetinteger nullable

Number of objects to skip before returning results.

Example:3

Number of objects to skip before returning results.

intervalinteger nullable

Filter by time interval in days (e.g., 30 for last 30 days).

Example:2500

Filter by time interval in days (e.g., 30 for last 30 days).

payment_intentstring nullable

Filter by payment intent ID.

Example:fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by payment intent ID.

status'open' | 'paid' | 'complete' | 'canceled' | 'expired'

The status of the checkout session.

Example:open

Filter by checkout session status.

customerstring nullable

Filter by customer ID.

Example:fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by customer ID.

emailstring email nullable

Filter results by customer email address.

Example:john.doe@example.com

Filter results by customer email address.

subscriptionstring nullable

Filter by subscription ID.

Example:fsub_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Filter by subscription ID.

client_reference_idstring nullable

Filter by the client reference ID you provided when creating the checkout session.

Example:example_value

Filter by the client reference ID you provided when creating the checkout session.

expand_customerboolean nullable

If true, expands the customer object in the response.

expand_payment_intentboolean nullable

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

expandstring

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

created[gt]string

A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. 2026-06-15T14:30:00Z).

Example:string

Return sessions created after this timestamp (exclusive). ISO 8601 format.

created[gte]string

A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. 2026-06-15T14:30:00Z).

Example:string

Return sessions created at or after this timestamp (inclusive). ISO 8601 format.

created[lt]string

A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. 2026-06-15T14:30:00Z).

Example:string

Return sessions created before this timestamp (exclusive). ISO 8601 format.

created[lte]string

A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. 2026-06-15T14:30:00Z).

Example:string

Return sessions created at or before this timestamp (inclusive). ISO 8601 format.

starting_afterstring nullable

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.

Example:fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA

ending_beforestring nullable

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.

Example:fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA

has_disputesboolean nullable

Return only checkout sessions with any associated dispute

Response

An envelope wrapping a list of checkout session objects.

Example response

{
  "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": [],
      "disputes": [],
      "capture_method": "automatic",
      "checkout_session_id": "fcs_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "client_reference_id": "example_value",
      "created_at": 2500,
      "expires_at": 2500,
      "invoice": "fin_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "hsa_fsa_eligible": false,
      "letter_of_medical_necessity_required": false,
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "mode": "payment",
      "redirect_url": "https://example.com",
      "refunds": [],
      "setup_intent": "fseti_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "shipping_address_collection": false,
      "status": "open",
      "success_url": "https://example.com",
      "fees": [],
      "test_mode": false,
      "total_details": {},
      "setup_future_use": "on_session"
    }
  ]
}