Retrieve a checkout session

curl --request GET \
  --url https://sandboxapi.kelviq.com/api/v1/checkout/sessions/{session_id}/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/checkout/sessions/{session_id}/"

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/{session_id}/', 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/{session_id}/",
  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/{session_id}/"

	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/{session_id}/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/checkout/sessions/{session_id}/")

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

{
  "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,
  "currency": "usd",
  "currencySymbol": "$",
  "status": "open",
  "createdOn": "2026-07-29T10:30:00Z",
  "selectedData": {},
  "offeringData": {},
  "data": {},
  "customFieldsData": {},
  "metadata": {},
  "customization": {},
  "trialPeriod": 0,
  "order": {
    "id": "ORD-20260729103000-AB3K9",
    "status": "COMPLETE",
    "paidAt": "2026-07-29T10:31:12Z",
    "createdOn": "2026-07-29T10:30:55Z",
    "billingType": "SUBSCRIPTION",
    "isTrial": false,
    "amountSubtotal": "261.00",
    "amountDiscount": "0.00",
    "amountTax": "0.00",
    "amountTotal": "261.00",
    "saleCurrency": "USD",
    "saleCurrencySymbol": "$",
    "invoiceId": "INV-20260729103000-XZ7Q1"
  },
  "subscription": {
    "id": "09d706ca-58f3-4fb2-818f-5b8623d67e6e",
    "recurrence": "month",
    "billingPeriodStartTime": "2026-07-29T10:31:12Z",
    "billingPeriodEndTime": "2026-08-29T10:31:12Z",
    "startDate": "2026-07-29",
    "endDate": null,
    "status": "active",
    "amount": "261.00",
    "currency": "usd",
    "trialDaysRemaining": 0,
    "billingType": "SUBSCRIPTION",
    "recurrenceUnit": 1,
    "recurrenceType": "MONTH"
  },
  "paymentMethod": {
    "paymentMethodType": "card",
    "paymentMethodName": "visa",
    "last4": "4242"
  }
}

GET

checkout

sessions

{session_id}

Retrieve a checkout session

curl --request GET \
  --url https://sandboxapi.kelviq.com/api/v1/checkout/sessions/{session_id}/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandboxapi.kelviq.com/api/v1/checkout/sessions/{session_id}/"

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/{session_id}/', 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/{session_id}/",
  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/{session_id}/"

	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/{session_id}/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandboxapi.kelviq.com/api/v1/checkout/sessions/{session_id}/")

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

{
  "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,
  "currency": "usd",
  "currencySymbol": "$",
  "status": "open",
  "createdOn": "2026-07-29T10:30:00Z",
  "selectedData": {},
  "offeringData": {},
  "data": {},
  "customFieldsData": {},
  "metadata": {},
  "customization": {},
  "trialPeriod": 0,
  "order": {
    "id": "ORD-20260729103000-AB3K9",
    "status": "COMPLETE",
    "paidAt": "2026-07-29T10:31:12Z",
    "createdOn": "2026-07-29T10:30:55Z",
    "billingType": "SUBSCRIPTION",
    "isTrial": false,
    "amountSubtotal": "261.00",
    "amountDiscount": "0.00",
    "amountTax": "0.00",
    "amountTotal": "261.00",
    "saleCurrency": "USD",
    "saleCurrencySymbol": "$",
    "invoiceId": "INV-20260729103000-XZ7Q1"
  },
  "subscription": {
    "id": "09d706ca-58f3-4fb2-818f-5b8623d67e6e",
    "recurrence": "month",
    "billingPeriodStartTime": "2026-07-29T10:31:12Z",
    "billingPeriodEndTime": "2026-08-29T10:31:12Z",
    "startDate": "2026-07-29",
    "endDate": null,
    "status": "active",
    "amount": "261.00",
    "currency": "usd",
    "trialDaysRemaining": 0,
    "billingType": "SUBSCRIPTION",
    "recurrenceUnit": 1,
    "recurrenceType": "MONTH"
  },
  "paymentMethod": {
    "paymentMethodType": "card",
    "paymentMethodName": "visa",
    "last4": "4242"
  }
}

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

Authorization

string

header

required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

session_id

string

required

The checkout session ID.

Response

The checkout session.

A single checkout session, with the order/subscription/payment method it produced.

string

Checkout session ID.

Example:

"cs_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6q7R8s9T0u1V2"

customer

object

Show child attributes

product

object

A product in the catalog. Each product can have multiple plans, images and files.

Show child attributes

billingAddress

object | null

The billing address of the customer.

Show child attributes

discountCode

string | null

Example:

null

taxId

string | null

Example:

null

currency

string | null

Example:

"usd"

currencySymbol

string

Example:

"$"

status

string

Typical values: open, processing, success, expired.

Example:

"open"

createdOn

string<date-time>

Example:

"2026-07-29T10:30:00Z"

selectedData

object

Selected plan/addons for this session.

offeringData

object

Snapshot of the product/plan offering shown at checkout.

data

object

customFieldsData

object

Customer-submitted responses to custom checkout fields.

metadata

object

Customer-supplied metadata passed at checkout session creation.

customization

object

Customer-supplied checkout UI customization passed at session creation.

trialPeriod

integer

Trial period length in days.

Example:

0

order

object | null

null until an order has been created from this session.

Show child attributes

subscription

object | null

null if the order has no linked subscription.

Show child attributes

paymentMethod

object | null

The payment method used for the order's first successful transaction. null if no successful transaction exists yet.

Show child attributes

List checkout sessions

List checkout session events

Get Started

API Documentation

Retrieve a checkout session

Authorizations

Path Parameters

Response