curl --request GET \
--url https://{defaultHost}/v1/checkouts \
--header 'Authorization: Bearer <token>'{
"object": "list",
"pagination": {
"count": 1,
"limit": 20,
"page": 1,
"url": "/v1/checkouts"
},
"data": [
{
"id": "6ed7fc27-d696-409c-b80e-18150c8ba72b",
"object": "checkout",
"abandoned_checkout_enabled": true,
"amount_due": 2900,
"applied_balance_amount": 0,
"available_countries": [],
"billing_matches_shipping": true,
"checkout_fees_amount": 0,
"credited_balance_amount": 0,
"currency": "usd",
"discount_amount": 0,
"email": "[email protected]",
"external_url": null,
"first_name": null,
"free_shipping_choice_shortage_amount": null,
"full_amount": 2900,
"group_key": null,
"inherited_email": "[email protected]",
"inherited_name": null,
"inherited_phone": null,
"ip_address": null,
"last_name": null,
"live_mode": true,
"manual_payment": false,
"metadata": {},
"name": null,
"net_paid_amount": 0,
"paid_amount": 0,
"g_weight": 0,
"paid_at": null,
"payment_method_required": true,
"phone_required": false,
"portal_url": "http://app.example.com/portal_redirect/checkouts/6ed7fc27-d696-409c-b80e-18150c8ba72b",
"phone": null,
"proration_amount": 0,
"refunded_amount": 0,
"remaining_amount_due": 2900,
"reusable_payment_method_required": false,
"selected_shipping_choice_required": false,
"shipping_address_accuracy_requirement": "none",
"shipping_amount": 0,
"shipping_enabled": false,
"shipping_fees_amount": 0,
"shipping_tax_amount": 0,
"shipping_tax_rate": 0,
"status": "draft",
"subtotal_amount": 2900,
"tax_amount": 0,
"tax_behavior": "exclusive",
"tax_breakdown": [],
"tax_enabled": false,
"tax_label": null,
"tax_status": "disabled",
"total_amount": 2900,
"total_savings_amount": 0,
"trial_amount": 0,
"upsells_expire_at": null,
"billing_address": null,
"current_payment_intent": null,
"current_upsell": null,
"invoice": null,
"last_click": null,
"customer": "06485ae9-46ca-41d5-bcd3-a795cfd73bdd",
"discount": null,
"manual_payment_method": null,
"order": null,
"payment_method": null,
"inherited_billing_address": null,
"inherited_shipping_address": null,
"inherited_tax_identifier": null,
"referral": null,
"shipping_address": null,
"tax_identifier": null,
"selected_shipping_choice": null,
"upsell_funnel": null,
"created_at": 1767909679,
"updated_at": 1767909679
}
]
}Returns a list of your checkouts.
curl --request GET \
--url https://{defaultHost}/v1/checkouts \
--header 'Authorization: Bearer <token>'{
"object": "list",
"pagination": {
"count": 1,
"limit": 20,
"page": 1,
"url": "/v1/checkouts"
},
"data": [
{
"id": "6ed7fc27-d696-409c-b80e-18150c8ba72b",
"object": "checkout",
"abandoned_checkout_enabled": true,
"amount_due": 2900,
"applied_balance_amount": 0,
"available_countries": [],
"billing_matches_shipping": true,
"checkout_fees_amount": 0,
"credited_balance_amount": 0,
"currency": "usd",
"discount_amount": 0,
"email": "[email protected]",
"external_url": null,
"first_name": null,
"free_shipping_choice_shortage_amount": null,
"full_amount": 2900,
"group_key": null,
"inherited_email": "[email protected]",
"inherited_name": null,
"inherited_phone": null,
"ip_address": null,
"last_name": null,
"live_mode": true,
"manual_payment": false,
"metadata": {},
"name": null,
"net_paid_amount": 0,
"paid_amount": 0,
"g_weight": 0,
"paid_at": null,
"payment_method_required": true,
"phone_required": false,
"portal_url": "http://app.example.com/portal_redirect/checkouts/6ed7fc27-d696-409c-b80e-18150c8ba72b",
"phone": null,
"proration_amount": 0,
"refunded_amount": 0,
"remaining_amount_due": 2900,
"reusable_payment_method_required": false,
"selected_shipping_choice_required": false,
"shipping_address_accuracy_requirement": "none",
"shipping_amount": 0,
"shipping_enabled": false,
"shipping_fees_amount": 0,
"shipping_tax_amount": 0,
"shipping_tax_rate": 0,
"status": "draft",
"subtotal_amount": 2900,
"tax_amount": 0,
"tax_behavior": "exclusive",
"tax_breakdown": [],
"tax_enabled": false,
"tax_label": null,
"tax_status": "disabled",
"total_amount": 2900,
"total_savings_amount": 0,
"trial_amount": 0,
"upsells_expire_at": null,
"billing_address": null,
"current_payment_intent": null,
"current_upsell": null,
"invoice": null,
"last_click": null,
"customer": "06485ae9-46ca-41d5-bcd3-a795cfd73bdd",
"discount": null,
"manual_payment_method": null,
"order": null,
"payment_method": null,
"inherited_billing_address": null,
"inherited_shipping_address": null,
"inherited_tax_identifier": null,
"referral": null,
"shipping_address": null,
"tax_identifier": null,
"selected_shipping_choice": null,
"upsell_funnel": null,
"created_at": 1767909679,
"updated_at": 1767909679
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Only return objects that belong to the given customers.
Only return objects with the given group keys.
Only return objects with the given IDs.
A limit on the number of items to be returned, between 1 and 100.
Only return objects that are live mode or test mode.
The page of items you want returned.
Only return objects that belong to the given products.
Only return objects with the given status.
Was this page helpful?