curl --request GET \
--url https://console.advinservers.com/api/v1/client/checkout/{uuid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/checkout/{uuid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://console.advinservers.com/api/v1/client/checkout/{uuid}', 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://console.advinservers.com/api/v1/client/checkout/{uuid}",
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://console.advinservers.com/api/v1/client/checkout/{uuid}"
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://console.advinservers.com/api/v1/client/checkout/{uuid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/checkout/{uuid}")
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{
"uuid": "53a832f9-e85e-44b5-af03-2ef26110686d",
"status": "awaiting_gateway",
"status_label": "Waiting for payment",
"progress_message": "Opening the payment form…",
"last_error_code": null,
"description": "Account credit · 25.00 USD",
"line_items": [
{
"label": "Account credit",
"amount": "25.00 USD"
},
{
"label": "Added to your balance once the payment clears",
"amount": null
}
],
"amount": "25.00",
"currency": "USD",
"total_display": "25.00 USD",
"option": "paddle_once",
"options": [
{
"value": "paddle_once",
"label": "Credit Card or PayPal",
"shortLabel": "Credit Card or PayPal",
"description": "Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself.",
"provider": "paddle",
"providerName": "Paddle",
"recurring": false
},
{
"value": "btcpay_once",
"label": "Cryptocurrency (one-time payment)",
"shortLabel": "BTCPay",
"description": "Pay once in Bitcoin or another supported coin. Confirmations can take a few minutes.",
"provider": "btcpay",
"providerName": "BTCPay Server",
"recurring": false
}
],
"merchant_of_record": true,
"notes": null,
"promo_code": null,
"redirect_url": null,
"paddle": {
"transaction_id": "txn_01j8m4x7c2k9q5v3r6t1w8y0za",
"client_token": "live_7d0b6c1f3e9a24c58b71e2f4d93",
"environment": "production"
},
"return_path": "/add-funds",
"expires_at": "2026-09-14T17:12:09+00:00",
"settled_at": null,
"created_at": "2026-09-14T16:42:09+00:00",
"is_live": true,
"can_choose": false,
"is_settling": false,
"enabled": true,
"payment_token": "eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3"
}{
"message": "Unauthenticated."
}{
"message": "This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."
}{
"message": "Not found."
}{
"message": "Too Many Attempts."
}Get a checkout
Overview
Returns a checkout’s purchase details, itemised total, payment options and next payment step.
payment_token is regenerated on each request and links the displayed amount to the payment. Fetch the checkout immediately before starting payment and use that token. The token is null if no further payment attempt is allowed. enabled is false if payments are unavailable. Checkouts belonging to another account return 404.
Permissions
Requires the billing.purchase (Make purchases) permission for the selected team. Resources outside that team return 404.
curl --request GET \
--url https://console.advinservers.com/api/v1/client/checkout/{uuid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://console.advinservers.com/api/v1/client/checkout/{uuid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://console.advinservers.com/api/v1/client/checkout/{uuid}', 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://console.advinservers.com/api/v1/client/checkout/{uuid}",
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://console.advinservers.com/api/v1/client/checkout/{uuid}"
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://console.advinservers.com/api/v1/client/checkout/{uuid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://console.advinservers.com/api/v1/client/checkout/{uuid}")
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{
"uuid": "53a832f9-e85e-44b5-af03-2ef26110686d",
"status": "awaiting_gateway",
"status_label": "Waiting for payment",
"progress_message": "Opening the payment form…",
"last_error_code": null,
"description": "Account credit · 25.00 USD",
"line_items": [
{
"label": "Account credit",
"amount": "25.00 USD"
},
{
"label": "Added to your balance once the payment clears",
"amount": null
}
],
"amount": "25.00",
"currency": "USD",
"total_display": "25.00 USD",
"option": "paddle_once",
"options": [
{
"value": "paddle_once",
"label": "Credit Card or PayPal",
"shortLabel": "Credit Card or PayPal",
"description": "Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself.",
"provider": "paddle",
"providerName": "Paddle",
"recurring": false
},
{
"value": "btcpay_once",
"label": "Cryptocurrency (one-time payment)",
"shortLabel": "BTCPay",
"description": "Pay once in Bitcoin or another supported coin. Confirmations can take a few minutes.",
"provider": "btcpay",
"providerName": "BTCPay Server",
"recurring": false
}
],
"merchant_of_record": true,
"notes": null,
"promo_code": null,
"redirect_url": null,
"paddle": {
"transaction_id": "txn_01j8m4x7c2k9q5v3r6t1w8y0za",
"client_token": "live_7d0b6c1f3e9a24c58b71e2f4d93",
"environment": "production"
},
"return_path": "/add-funds",
"expires_at": "2026-09-14T17:12:09+00:00",
"settled_at": null,
"created_at": "2026-09-14T16:42:09+00:00",
"is_live": true,
"can_choose": false,
"is_settling": false,
"enabled": true,
"payment_token": "eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3"
}{
"message": "Unauthenticated."
}{
"message": "This API key is not allowed to do that in this team. It needs the \"snapshot.delete\" permission."
}{
"message": "Not found."
}{
"message": "Too Many Attempts."
}Authorizations
Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.
Path Parameters
The uuid ID.
"53a832f9-e85e-44b5-af03-2ef26110686d"
Response
The record, as a JSON object. There is no envelope.
A checkout and its available payment options.
The uuid UUID.
"53a832f9-e85e-44b5-af03-2ef26110686d"
The value of status.
draft, awaiting_gateway, charging, recording, paid, expired, cancelled, payment_review "awaiting_gateway"
The status in the customer's words, written once on the enum.
"Waiting for payment"
The value of progress_message.
"Opening the payment form…"
The value of last_error_code.
null
What is being bought, or the invoice number when no name is available.
"Account credit · 25.00 USD"
The value of line_items.
Show child attributes
Show child attributes
[ { "label": "Account credit", "amount": "25.00 USD" }, { "label": "Added to your balance once the payment clears", "amount": null } ]
The decimal string the row holds. Money is never a float here: this is the figure the customer is about to be charged.
"25.00"
The three-letter currency code used for monetary amounts.
"USD"
The amount and its currency, rendered ready to print.
"25.00 USD"
The value of option.
paddle_once, paddle_subscription, btcpay_once, null "paddle_once"
The value of options.
Show child attributes
Show child attributes
[ { "value": "paddle_once", "label": "Credit Card or PayPal", "shortLabel": "Credit Card or PayPal", "description": "Pay once by card, PayPal or wallet. Nothing is stored and nothing renews by itself.", "provider": "paddle", "providerName": "Paddle", "recurring": false }, { "value": "btcpay_once", "label": "Cryptocurrency (one-time payment)", "shortLabel": "BTCPay", "description": "Pay once in Bitcoin or another supported coin. Confirmations can take a few minutes.", "provider": "btcpay", "providerName": "BTCPay Server", "recurring": false } ]
The value of merchant_of_record.
true
Optional notes about the request.
null
The value of promo_code.
null
The value of redirect_url.
null
The value of paddle.
Show child attributes
Show child attributes
{ "transaction_id": "txn_01j8m4x7c2k9q5v3r6t1w8y0za", "client_token": "live_7d0b6c1f3e9a24c58b71e2f4d93", "environment": "production" }
The value of return_path.
"/add-funds"
When this action or checkout expires, in UTC.
"2026-09-14T17:12:09+00:00"
The date and time for settled at, in UTC.
null
The date and time for created at, in UTC.
"2026-09-14T16:42:09+00:00"
Whether the checkout can still accept another payment attempt.
true
Whether the customer can choose.
false
Whether the resource is settling.
false
Whether the panel is taking payments at all.
true
The token a start request sends back, tied to the amount shown. Null when no further payment attempt is allowed.
"eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3"