Skip to main content
GET
/
checkout_configurations
List checkout configurations
curl --request GET \
  --url https://{defaultHost}/checkout_configurations \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://{defaultHost}/checkout_configurations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{defaultHost}/checkout_configurations', 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}/checkout_configurations",
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}/checkout_configurations"

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}/checkout_configurations")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{defaultHost}/checkout_configurations")

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
{
  "data": [
    {
      "id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "company_id": "<string>",
      "currency": "<string>",
      "plan": {
        "id": "<string>",
        "visibility": "<string>",
        "plan_type": "<string>",
        "release_method": "<string>",
        "currency": "<string>",
        "billing_period": 123,
        "expiration_days": 123,
        "initial_price": 123,
        "renewal_price": 123,
        "trial_period_days": 123,
        "three_ds_level": "<string>",
        "adaptive_pricing_enabled": true
      },
      "affiliate_code": "<string>",
      "metadata": {},
      "redirect_url": "<string>",
      "purchase_url": "<string>",
      "three_ds_level": "<string>",
      "payment_method_configuration": {
        "enabled": [
          "<string>"
        ],
        "disabled": [
          "<string>"
        ],
        "include_platform_defaults": true
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}
{
"error": {
"type": "<string>",
"message": "<string>"
}
}
{
"error": {
"type": "<string>",
"message": "<string>"
}
}

Authorizations

Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-08-1"

Query Parameters

company_id
string
required

Account ID, prefixed biz_.

plan_id
string

Only return checkout configurations for this plan ID, prefixed plan_.

created_before
integer

Only return checkout configurations created before this Unix timestamp.

created_after
integer

Only return checkout configurations created after this Unix timestamp.

order
enum<string>
default:created_at

Field used to sort checkout configurations.

Available options:
created_at
direction
enum<string>
default:desc

Sort direction. Defaults to desc.

Available options:
asc,
desc
first
integer

Number of checkout configurations to return.

after
string

Cursor for the next page of results.

Response

checkout configurations listed

data
object[]
required
page_info
object
required