List
curl --request GET \
--url https://{defaultHost}/v1/checkouts \
--header 'Authorization: Bearer <token>'import requests
url = "https://{defaultHost}/v1/checkouts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{defaultHost}/v1/checkouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{defaultHost}/v1/checkouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/v1/checkouts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{defaultHost}/v1/checkouts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/checkouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"pagination": {
"count": 1,
"limit": 20,
"page": 1,
"url": "/v1/checkouts"
},
"data": [
{
"id": "eee6ab00-bad9-4ab7-bf0f-fb17f8ce735c",
"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": "customer@example.com",
"external_url": null,
"first_name": null,
"free_shipping_choice_shortage_amount": null,
"full_amount": 2900,
"group_key": null,
"inherited_email": "customer@example.com",
"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,
"latitude": null,
"longitude": null,
"paid_at": null,
"payment_method_required": true,
"phone_required": false,
"portal_url": "http://app.example.com/portal_redirect/checkouts/eee6ab00-bad9-4ab7-bf0f-fb17f8ce735c",
"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": "68f80327-6c13-4fb1-962a-d5f26fa18d59",
"discount": null,
"geo_address": 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": 1782485812,
"updated_at": 1782485812
}
]
}Checkouts
List
Returns a list of your checkouts.
GET
/
v1
/
checkouts
List
curl --request GET \
--url https://{defaultHost}/v1/checkouts \
--header 'Authorization: Bearer <token>'import requests
url = "https://{defaultHost}/v1/checkouts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{defaultHost}/v1/checkouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{defaultHost}/v1/checkouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/v1/checkouts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{defaultHost}/v1/checkouts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/checkouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"pagination": {
"count": 1,
"limit": 20,
"page": 1,
"url": "/v1/checkouts"
},
"data": [
{
"id": "eee6ab00-bad9-4ab7-bf0f-fb17f8ce735c",
"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": "customer@example.com",
"external_url": null,
"first_name": null,
"free_shipping_choice_shortage_amount": null,
"full_amount": 2900,
"group_key": null,
"inherited_email": "customer@example.com",
"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,
"latitude": null,
"longitude": null,
"paid_at": null,
"payment_method_required": true,
"phone_required": false,
"portal_url": "http://app.example.com/portal_redirect/checkouts/eee6ab00-bad9-4ab7-bf0f-fb17f8ce735c",
"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": "68f80327-6c13-4fb1-962a-d5f26fa18d59",
"discount": null,
"geo_address": 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": 1782485812,
"updated_at": 1782485812
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
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?
⌘I