Start a checkout payment

curl --request POST \
  --url https://console.advinservers.com/api/v1/client/checkout/{uuid}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "option": "paddle_once",
  "payment_token": "eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3",
  "notes": null,
  "promo_code": null
}
'

import requests

url = "https://console.advinservers.com/api/v1/client/checkout/{uuid}/start"

payload = {
    "option": "paddle_once",
    "payment_token": "eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3",
    "notes": None,
    "promo_code": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    option: 'paddle_once',
    payment_token: 'eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3',
    notes: null,
    promo_code: null
  })
};

fetch('https://console.advinservers.com/api/v1/client/checkout/{uuid}/start', 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}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'option' => 'paddle_once',
    'payment_token' => 'eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3',
    'notes' => null,
    'promo_code' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://console.advinservers.com/api/v1/client/checkout/{uuid}/start"

	payload := strings.NewReader("{\n  \"option\": \"paddle_once\",\n  \"payment_token\": \"eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3\",\n  \"notes\": null,\n  \"promo_code\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://console.advinservers.com/api/v1/client/checkout/{uuid}/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"option\": \"paddle_once\",\n  \"payment_token\": \"eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3\",\n  \"notes\": null,\n  \"promo_code\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.advinservers.com/api/v1/client/checkout/{uuid}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"option\": \"paddle_once\",\n  \"payment_token\": \"eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3\",\n  \"notes\": null,\n  \"promo_code\": null\n}"

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": "The name field is required.",
  "errors": {}
}

{
  "message": "Too Many Attempts."
}

Checkout

Start a checkout payment

Overview

Selects a payment option and returns the next payment step. Send option from the checkout’s options and payment_token from a fresh checkout response. Tokens for a different amount are rejected. notes and promo_code are optional.

This request does not take payment. The response includes either a redirect_url for the browser or details for opening an embedded payment widget. Rate limits apply per account, not per IP address.

Permissions

Requires the billing.purchase (Make purchases) permission for the selected team. Resources outside that team return 404.

POST

checkout

{uuid}

start

Start a checkout payment

curl --request POST \
  --url https://console.advinservers.com/api/v1/client/checkout/{uuid}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "option": "paddle_once",
  "payment_token": "eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3",
  "notes": null,
  "promo_code": null
}
'

import requests

url = "https://console.advinservers.com/api/v1/client/checkout/{uuid}/start"

payload = {
    "option": "paddle_once",
    "payment_token": "eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3",
    "notes": None,
    "promo_code": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    option: 'paddle_once',
    payment_token: 'eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3',
    notes: null,
    promo_code: null
  })
};

fetch('https://console.advinservers.com/api/v1/client/checkout/{uuid}/start', 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}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'option' => 'paddle_once',
    'payment_token' => 'eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3',
    'notes' => null,
    'promo_code' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://console.advinservers.com/api/v1/client/checkout/{uuid}/start"

	payload := strings.NewReader("{\n  \"option\": \"paddle_once\",\n  \"payment_token\": \"eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3\",\n  \"notes\": null,\n  \"promo_code\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://console.advinservers.com/api/v1/client/checkout/{uuid}/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"option\": \"paddle_once\",\n  \"payment_token\": \"eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3\",\n  \"notes\": null,\n  \"promo_code\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.advinservers.com/api/v1/client/checkout/{uuid}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"option\": \"paddle_once\",\n  \"payment_token\": \"eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3\",\n  \"notes\": null,\n  \"promo_code\": null\n}"

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": "The name field is required.",
  "errors": {}
}

{
  "message": "Too Many Attempts."
}

Authorizations

Authorization

string

header

required

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

uuid

string

required

The uuid ID.

Example:

"53a832f9-e85e-44b5-af03-2ef26110686d"

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

option

enum<string>

required

The value of option.

Available options:

paddle_once,

paddle_subscription,

btcpay_once

payment_token

string

required

The value of payment_token.

Maximum string length: 4096

notes

string | null

Optional notes about the request.

Maximum string length: 2000

The value of promo_code.

Maximum string length: 64

Pattern: ^[A-Za-z0-9_-]+$

Response

The record, as a JSON object. There is no envelope.

A checkout and its available payment options.

uuid

string

required

The uuid UUID.

Example:

"53a832f9-e85e-44b5-af03-2ef26110686d"

status

enum<string>

required

The value of status.

Available options:

draft,

awaiting_gateway,

charging,

recording,

paid,

expired,

cancelled,

payment_review

Example:

"awaiting_gateway"

status_label

string

required

The status in the customer's words, written once on the enum.

Example:

"Waiting for payment"

progress_message

string | null

required

The value of progress_message.

Example:

"Opening the payment form…"

last_error_code

string | null

required

The value of last_error_code.

Example:

null

description

string

required

What is being bought, or the invoice number when no name is available.

Example:

"Account credit · 25.00 USD"

line_items

CheckoutLineItemData · object[]

required

The value of line_items.

Show child attributes

Example:

[
  {
    "label": "Account credit",
    "amount": "25.00 USD"
  },
  {
    "label": "Added to your balance once the payment clears",
    "amount": null
  }
]

amount

string

required

The decimal string the row holds. Money is never a float here: this is the figure the customer is about to be charged.

Example:

"25.00"

currency

string

required

The three-letter currency code used for monetary amounts.

Example:

"USD"

total_display

string

required

The amount and its currency, rendered ready to print.

Example:

"25.00 USD"

option

enum<string> | null

required

The value of option.

Available options:

paddle_once,

paddle_subscription,

btcpay_once,

null

Example:

"paddle_once"

options

CheckoutPaymentOptionData · object[]

required

The value of options.

Show child attributes

Example:

[
  {
    "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

boolean

required

The value of merchant_of_record.

Example:

true

notes

string | null

required

Optional notes about the request.

Example:

null

The value of promo_code.

Example:

null

redirect_url

string | null

required

The value of redirect_url.

Example:

null

paddle

CheckoutPaddleHandoffData · object | null

required

The value of paddle.

Show child attributes

Example:

{
  "transaction_id": "txn_01j8m4x7c2k9q5v3r6t1w8y0za",
  "client_token": "live_7d0b6c1f3e9a24c58b71e2f4d93",
  "environment": "production"
}

return_path

string | null

required

The value of return_path.

Example:

"/add-funds"

expires_at

string | null

required

When this action or checkout expires, in UTC.

Example:

"2026-09-14T17:12:09+00:00"

settled_at

string | null

required

The date and time for settled at, in UTC.

Example:

null

created_at

string | null

required

The date and time for created at, in UTC.

Example:

"2026-09-14T16:42:09+00:00"

is_live

boolean

required

Whether the checkout can still accept another payment attempt.

Example:

true

can_choose

boolean

required

Whether the customer can choose.

Example:

false

is_settling

boolean

required

Whether the resource is settling.

Example:

false

enabled

boolean

required

Whether the panel is taking payments at all.

Example:

true

payment_token

string | null

required

The token a start request sends back, tied to the amount shown. Null when no further payment attempt is allowed.

Example:

"eyJ2ZXJzaW9uIjoxLCJub25jZSI6ImRkMzA4NTEwYWVjOGY5YmI1ZTgyYzZiOGMwZWUxNGJhODVhNGE1ODhkZGI0NzA4YTJiNzM3ZWU4MWJjYzZiYWIiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NDI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCIsInBheW1lbnRfY29uZmlndXJhdGlvbl9maW5nZXJwcmludCI6IjViMWYwYzlhZDI3ZTRlMTMiLCJjaGVja291dF91dWlkIjoiNTNhODMyZjktZTg1ZS00NGI1LWFmMDMtMmVmMjYxMTA2ODZkIiwid2htY3NfaW52b2ljZV9pZCI6MTgzODYsImFtb3VudF9taW5vciI6MjUwMCwiY3VycmVuY3kiOiJVU0QifQ.a038063df5120b97140f1962351401be13540e9a3dfd19ff30248d53cdab66a3"

Getting Started

Endpoints

Start a checkout payment

Overview

Permissions

Authorizations

Path Parameters

Body

Response