List checkout sessions
curl --request GET \
--url https://sandboxapi.kelviq.com/api/v1/checkout/sessions/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandboxapi.kelviq.com/api/v1/checkout/sessions/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandboxapi.kelviq.com/api/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://sandboxapi.kelviq.com/api/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: 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://sandboxapi.kelviq.com/api/v1/checkout/sessions/"
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://sandboxapi.kelviq.com/api/v1/checkout/sessions/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandboxapi.kelviq.com/api/v1/checkout/sessions/")
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{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "cs_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6q7R8s9T0u1V2",
"customer": {
"customerId": "testuser",
"name": "Jane Smith",
"email": "jane@example.com"
},
"product": {
"id": "0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de",
"identifier": "pro-suite",
"name": "Pro Suite",
"description": "Premium tools for growing teams.",
"taxCode": "saas",
"createdBy": "Jane Smith",
"modifiedOn": "2025-04-12T08:21:14.910Z",
"images": [
{
"id": "1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31",
"name": "hero-banner.png",
"image": "media/.../products/<id>/<uuid>/hero-banner.png",
"ordering": 0,
"thumbnail": true,
"enabled": true
}
]
},
"billingAddress": {
"country": "IN",
"line1": "123 Main Street",
"line2": "Apt 4B",
"postalCode": "560001",
"city": "Bangalore",
"state": "Karnataka"
},
"discountCode": null,
"taxId": null,
"amount": "40.00",
"currency": "usd",
"currencySymbol": "$",
"status": "open",
"createdOn": "2026-07-29T10:30:00Z",
"selectedData": {},
"offeringData": {},
"data": {},
"customFieldsData": {},
"metadata": {},
"customization": {},
"trialPeriod": 0
}
]
}Checkout Sessions
List checkout sessions
Returns a paginated list of checkout sessions for the authenticated organization, newest first.
GET
/
checkout
/
sessions
/
List checkout sessions
curl --request GET \
--url https://sandboxapi.kelviq.com/api/v1/checkout/sessions/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandboxapi.kelviq.com/api/v1/checkout/sessions/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandboxapi.kelviq.com/api/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://sandboxapi.kelviq.com/api/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: 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://sandboxapi.kelviq.com/api/v1/checkout/sessions/"
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://sandboxapi.kelviq.com/api/v1/checkout/sessions/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandboxapi.kelviq.com/api/v1/checkout/sessions/")
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{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "cs_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6q7R8s9T0u1V2",
"customer": {
"customerId": "testuser",
"name": "Jane Smith",
"email": "jane@example.com"
},
"product": {
"id": "0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de",
"identifier": "pro-suite",
"name": "Pro Suite",
"description": "Premium tools for growing teams.",
"taxCode": "saas",
"createdBy": "Jane Smith",
"modifiedOn": "2025-04-12T08:21:14.910Z",
"images": [
{
"id": "1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31",
"name": "hero-banner.png",
"image": "media/.../products/<id>/<uuid>/hero-banner.png",
"ordering": 0,
"thumbnail": true,
"enabled": true
}
]
},
"billingAddress": {
"country": "IN",
"line1": "123 Main Street",
"line2": "Apt 4B",
"postalCode": "560001",
"city": "Bangalore",
"state": "Karnataka"
},
"discountCode": null,
"taxId": null,
"amount": "40.00",
"currency": "usd",
"currencySymbol": "$",
"status": "open",
"createdOn": "2026-07-29T10:30:00Z",
"selectedData": {},
"offeringData": {},
"data": {},
"customFieldsData": {},
"metadata": {},
"customization": {},
"trialPeriod": 0
}
]
}Click the base URL in the API playground and select the Sandbox host for test data or the Production host for live data. Use credentials from the same environment.
Authorizations
The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'
Query Parameters
Search by session ID, customer name, email, customer ID, or product name.
Filter by session status.
Example:
"open"
Include sessions created on or after this date.
Include sessions created on or before this date.
Number of results per page. Defaults to 10, maximum 100.
Required range:
1 <= x <= 100Page number to return.
Required range:
x >= 1