List all checkout sessions
curl --request GET \
--url https://api.yorlet.com/v1/checkout_sessions \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/checkout_sessions"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.yorlet.com/v1/checkout_sessions', 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://api.yorlet.com/v1/checkout_sessions",
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: <api-key>"
],
]);
$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://api.yorlet.com/v1/checkout_sessions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.yorlet.com/v1/checkout_sessions")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/checkout_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "checkout_session",
"completed_at": 123,
"consent_collection": {
"terms_of_service": true
},
"custom_text": {
"terms_of_service": {
"message": "<string>"
}
},
"currency": "gbp",
"customer": "<string>",
"default_payment_method": "<string>",
"description": "<string>",
"payment_method_types": [
"<string>"
],
"return_url": "<string>",
"subscription_data": {
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": {
"day_of_month": 16
},
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"description": "<string>",
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"metadata": {},
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"application": "<string>",
"interval_count": 123,
"invoice_settings": {
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"use_future_billing_date": true
},
"subscription": "<string>",
"url": "<string>",
"account": "<string>",
"deleted": false,
"merchant": {
"business_name": "<string>",
"color": "<string>",
"country": "<string>",
"display_name": "<string>",
"icon": "<string>",
"id": "<string>",
"support_email": "<string>",
"support_phone": "<string>",
"support_website": "<string>",
"terms_of_service_url": "<string>"
},
"metadata": {}
}
]
}Checkout Sessions
List all checkout sessions
Returns a list of checkout sessions. The checkout sessions are returned sorted by creation date, with the most recent checkout sessions appearing first.
GET
/
v1
/
checkout_sessions
List all checkout sessions
curl --request GET \
--url https://api.yorlet.com/v1/checkout_sessions \
--header 'Authorization: <api-key>'import requests
url = "https://api.yorlet.com/v1/checkout_sessions"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.yorlet.com/v1/checkout_sessions', 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://api.yorlet.com/v1/checkout_sessions",
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: <api-key>"
],
]);
$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://api.yorlet.com/v1/checkout_sessions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.yorlet.com/v1/checkout_sessions")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/checkout_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "checkout_session",
"completed_at": 123,
"consent_collection": {
"terms_of_service": true
},
"custom_text": {
"terms_of_service": {
"message": "<string>"
}
},
"currency": "gbp",
"customer": "<string>",
"default_payment_method": "<string>",
"description": "<string>",
"payment_method_types": [
"<string>"
],
"return_url": "<string>",
"subscription_data": {
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": {
"day_of_month": 16
},
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"description": "<string>",
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"metadata": {},
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"application": "<string>",
"interval_count": 123,
"invoice_settings": {
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"items": [
{
"price_data": {
"amount": 123,
"currency": "<string>",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"use_future_billing_date": true
},
"subscription": "<string>",
"url": "<string>",
"account": "<string>",
"deleted": false,
"merchant": {
"business_name": "<string>",
"color": "<string>",
"country": "<string>",
"display_name": "<string>",
"icon": "<string>",
"id": "<string>",
"support_email": "<string>",
"support_phone": "<string>",
"support_website": "<string>",
"terms_of_service_url": "<string>"
},
"metadata": {}
}
]
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Response
200 - application/json
A object with a data property that contains an array of checkout sessions.
Was this page helpful?
⌘I