Error
A valid request URL is required to generate request examples{
"data": [
{
"id": "<string>",
"object": "checkout_session",
"merchant_id": "<string>",
"livemode": true,
"mode": "payment",
"ui_mode": "hosted",
"submit_type": "auto",
"status": "open",
"payment_status": "paid",
"success_url": "<string>",
"cancel_url": "<string>",
"locale": "<string>",
"customer": "<string>",
"customer_email": "<string>",
"client_reference_id": "<string>",
"line_items": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "<string>",
"quantity": 123,
"fulfillment_type": "digital",
"tip_eligible": true,
"metadata": {},
"price_id": "<string>",
"product_id": "<string>",
"recurring": {
"interval": "<string>",
"interval_count": 123
},
"adjustable_quantity": {
"enabled": true,
"minimum": 123,
"maximum": 123
},
"image_url": "<string>"
}
],
"collect_config": {
"email": "required",
"name": "required",
"phone": "required",
"address": "required",
"require_full_billing_address": true,
"require_shipping_address": true,
"require_phone": true,
"wallet_billing_mode": "min"
},
"amount_subtotal": 123,
"amount_total": 123,
"currency": "<string>",
"payment_intent_id": "<string>",
"expires_at": 123,
"metadata": {},
"created_at": 123,
"updated_at": 123,
"merchant": {
"name": "<string>"
},
"client_secret": "<string>",
"optional_items": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "<string>",
"quantity": 123,
"fulfillment_type": "digital",
"tip_eligible": true,
"metadata": {},
"price_id": "<string>",
"product_id": "<string>",
"recurring": {
"interval": "<string>",
"interval_count": 123
},
"adjustable_quantity": {
"enabled": true,
"minimum": 123,
"maximum": 123
},
"image_url": "<string>"
}
],
"selected_optional_item_ids": [
"<string>"
],
"payment_intent_client_secret": "<string>",
"setup_future_usage": "on_session",
"payment_error": {
"code": "<string>",
"message": "<string>",
"type": "card_error",
"decline_code": "<string>",
"decline_type": "authorization",
"retryable": true,
"doc_url": "<string>"
},
"payment_link_id": "<string>",
"tokenization": {
"provider": "<string>",
"tokenization_key": "<string>"
},
"provider": {
"name": "<string>",
"public_key": "<string>",
"config": {}
},
"url": "<string>",
"embed_url": "<string>"
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"error": {
"code": "INVALID_REQUEST",
"message": "line_items must not be empty"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Checkout endpoints
List checkout sessions
Returns a paginated list of checkout sessions, most recent first.
Supports cursor pagination (starting_after): when has_more is true,
pass the response’s next_cursor as starting_after to fetch the next
page. Secrets (client_secret, payment_intent_client_secret) are
stripped from all list responses.
GET
/
checkout
/
sessions
Error
A valid request URL is required to generate request examples{
"data": [
{
"id": "<string>",
"object": "checkout_session",
"merchant_id": "<string>",
"livemode": true,
"mode": "payment",
"ui_mode": "hosted",
"submit_type": "auto",
"status": "open",
"payment_status": "paid",
"success_url": "<string>",
"cancel_url": "<string>",
"locale": "<string>",
"customer": "<string>",
"customer_email": "<string>",
"client_reference_id": "<string>",
"line_items": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "<string>",
"quantity": 123,
"fulfillment_type": "digital",
"tip_eligible": true,
"metadata": {},
"price_id": "<string>",
"product_id": "<string>",
"recurring": {
"interval": "<string>",
"interval_count": 123
},
"adjustable_quantity": {
"enabled": true,
"minimum": 123,
"maximum": 123
},
"image_url": "<string>"
}
],
"collect_config": {
"email": "required",
"name": "required",
"phone": "required",
"address": "required",
"require_full_billing_address": true,
"require_shipping_address": true,
"require_phone": true,
"wallet_billing_mode": "min"
},
"amount_subtotal": 123,
"amount_total": 123,
"currency": "<string>",
"payment_intent_id": "<string>",
"expires_at": 123,
"metadata": {},
"created_at": 123,
"updated_at": 123,
"merchant": {
"name": "<string>"
},
"client_secret": "<string>",
"optional_items": [
{
"id": "<string>",
"name": "<string>",
"amount": 123,
"currency": "<string>",
"quantity": 123,
"fulfillment_type": "digital",
"tip_eligible": true,
"metadata": {},
"price_id": "<string>",
"product_id": "<string>",
"recurring": {
"interval": "<string>",
"interval_count": 123
},
"adjustable_quantity": {
"enabled": true,
"minimum": 123,
"maximum": 123
},
"image_url": "<string>"
}
],
"selected_optional_item_ids": [
"<string>"
],
"payment_intent_client_secret": "<string>",
"setup_future_usage": "on_session",
"payment_error": {
"code": "<string>",
"message": "<string>",
"type": "card_error",
"decline_code": "<string>",
"decline_type": "authorization",
"retryable": true,
"doc_url": "<string>"
},
"payment_link_id": "<string>",
"tokenization": {
"provider": "<string>",
"tokenization_key": "<string>"
},
"provider": {
"name": "<string>",
"public_key": "<string>",
"config": {}
},
"url": "<string>",
"embed_url": "<string>"
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"error": {
"code": "INVALID_REQUEST",
"message": "line_items must not be empty"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Query Parameters
Page size (default 20, max 100).
Required range:
1 <= x <= 100Cursor: a checkout session id (typically the previous response's next_cursor). Returns results strictly after it, newest first.
Response
A paginated list of checkout sessions.

