Create a checkout session

POST

checkout-sessions

curl --request POST \
  --url https://api.alguna.io/checkout-sessions \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "99.00",
  "checkout_intent": "payment",
  "client_reference_id": "order_1234",
  "currency": "USD",
  "customer": {
    "email": "billing@acme.com",
    "name": "Acme Corp",
    "address": {
      "city": "San Francisco",
      "country": "US",
      "line1": "123 Main St",
      "postal_code": "94105",
      "line2": "Suite 4",
      "state": "CA"
    },
    "first_name": "Ada",
    "last_name": "Lovelace",
    "website_url": "https://acme.com"
  },
  "customer_alias": "ext_39003209203023902",
  "customer_id": "cust_abc123",
  "expires_in_seconds": 86400,
  "legal_entity_id": "le_01H1VECT",
  "line_items": [
    {
      "description": "Implementation fee",
      "quantity": "1",
      "unit_price": "99.00",
      "product_name": "Onboarding"
    }
  ],
  "plan_id": "plan_01H1VECT",
  "success_url": "https://example.com/welcome"
}
'

import requests

url = "https://api.alguna.io/checkout-sessions"

payload = {
    "amount": "99.00",
    "checkout_intent": "payment",
    "client_reference_id": "order_1234",
    "currency": "USD",
    "customer": {
        "email": "billing@acme.com",
        "name": "Acme Corp",
        "address": {
            "city": "San Francisco",
            "country": "US",
            "line1": "123 Main St",
            "postal_code": "94105",
            "line2": "Suite 4",
            "state": "CA"
        },
        "first_name": "Ada",
        "last_name": "Lovelace",
        "website_url": "https://acme.com"
    },
    "customer_alias": "ext_39003209203023902",
    "customer_id": "cust_abc123",
    "expires_in_seconds": 86400,
    "legal_entity_id": "le_01H1VECT",
    "line_items": [
        {
            "description": "Implementation fee",
            "quantity": "1",
            "unit_price": "99.00",
            "product_name": "Onboarding"
        }
    ],
    "plan_id": "plan_01H1VECT",
    "success_url": "https://example.com/welcome"
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '99.00',
    checkout_intent: 'payment',
    client_reference_id: 'order_1234',
    currency: 'USD',
    customer: {
      email: 'billing@acme.com',
      name: 'Acme Corp',
      address: {
        city: 'San Francisco',
        country: 'US',
        line1: '123 Main St',
        postal_code: '94105',
        line2: 'Suite 4',
        state: 'CA'
      },
      first_name: 'Ada',
      last_name: 'Lovelace',
      website_url: 'https://acme.com'
    },
    customer_alias: 'ext_39003209203023902',
    customer_id: 'cust_abc123',
    expires_in_seconds: 86400,
    legal_entity_id: 'le_01H1VECT',
    line_items: [
      {
        description: 'Implementation fee',
        quantity: '1',
        unit_price: '99.00',
        product_name: 'Onboarding'
      }
    ],
    plan_id: 'plan_01H1VECT',
    success_url: 'https://example.com/welcome'
  })
};

fetch('https://api.alguna.io/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://api.alguna.io/checkout-sessions",
  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([
    'amount' => '99.00',
    'checkout_intent' => 'payment',
    'client_reference_id' => 'order_1234',
    'currency' => 'USD',
    'customer' => [
        'email' => 'billing@acme.com',
        'name' => 'Acme Corp',
        'address' => [
                'city' => 'San Francisco',
                'country' => 'US',
                'line1' => '123 Main St',
                'postal_code' => '94105',
                'line2' => 'Suite 4',
                'state' => 'CA'
        ],
        'first_name' => 'Ada',
        'last_name' => 'Lovelace',
        'website_url' => 'https://acme.com'
    ],
    'customer_alias' => 'ext_39003209203023902',
    'customer_id' => 'cust_abc123',
    'expires_in_seconds' => 86400,
    'legal_entity_id' => 'le_01H1VECT',
    'line_items' => [
        [
                'description' => 'Implementation fee',
                'quantity' => '1',
                'unit_price' => '99.00',
                'product_name' => 'Onboarding'
        ]
    ],
    'plan_id' => 'plan_01H1VECT',
    'success_url' => 'https://example.com/welcome'
  ]),
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "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://api.alguna.io/checkout-sessions"

	payload := strings.NewReader("{\n  \"amount\": \"99.00\",\n  \"checkout_intent\": \"payment\",\n  \"client_reference_id\": \"order_1234\",\n  \"currency\": \"USD\",\n  \"customer\": {\n    \"email\": \"billing@acme.com\",\n    \"name\": \"Acme Corp\",\n    \"address\": {\n      \"city\": \"San Francisco\",\n      \"country\": \"US\",\n      \"line1\": \"123 Main St\",\n      \"postal_code\": \"94105\",\n      \"line2\": \"Suite 4\",\n      \"state\": \"CA\"\n    },\n    \"first_name\": \"Ada\",\n    \"last_name\": \"Lovelace\",\n    \"website_url\": \"https://acme.com\"\n  },\n  \"customer_alias\": \"ext_39003209203023902\",\n  \"customer_id\": \"cust_abc123\",\n  \"expires_in_seconds\": 86400,\n  \"legal_entity_id\": \"le_01H1VECT\",\n  \"line_items\": [\n    {\n      \"description\": \"Implementation fee\",\n      \"quantity\": \"1\",\n      \"unit_price\": \"99.00\",\n      \"product_name\": \"Onboarding\"\n    }\n  ],\n  \"plan_id\": \"plan_01H1VECT\",\n  \"success_url\": \"https://example.com/welcome\"\n}")

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

	req.Header.Add("Alguna-Version", "<alguna-version>")
	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://api.alguna.io/checkout-sessions")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"99.00\",\n  \"checkout_intent\": \"payment\",\n  \"client_reference_id\": \"order_1234\",\n  \"currency\": \"USD\",\n  \"customer\": {\n    \"email\": \"billing@acme.com\",\n    \"name\": \"Acme Corp\",\n    \"address\": {\n      \"city\": \"San Francisco\",\n      \"country\": \"US\",\n      \"line1\": \"123 Main St\",\n      \"postal_code\": \"94105\",\n      \"line2\": \"Suite 4\",\n      \"state\": \"CA\"\n    },\n    \"first_name\": \"Ada\",\n    \"last_name\": \"Lovelace\",\n    \"website_url\": \"https://acme.com\"\n  },\n  \"customer_alias\": \"ext_39003209203023902\",\n  \"customer_id\": \"cust_abc123\",\n  \"expires_in_seconds\": 86400,\n  \"legal_entity_id\": \"le_01H1VECT\",\n  \"line_items\": [\n    {\n      \"description\": \"Implementation fee\",\n      \"quantity\": \"1\",\n      \"unit_price\": \"99.00\",\n      \"product_name\": \"Onboarding\"\n    }\n  ],\n  \"plan_id\": \"plan_01H1VECT\",\n  \"success_url\": \"https://example.com/welcome\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/checkout-sessions")

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

request = Net::HTTP::Post.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"99.00\",\n  \"checkout_intent\": \"payment\",\n  \"client_reference_id\": \"order_1234\",\n  \"currency\": \"USD\",\n  \"customer\": {\n    \"email\": \"billing@acme.com\",\n    \"name\": \"Acme Corp\",\n    \"address\": {\n      \"city\": \"San Francisco\",\n      \"country\": \"US\",\n      \"line1\": \"123 Main St\",\n      \"postal_code\": \"94105\",\n      \"line2\": \"Suite 4\",\n      \"state\": \"CA\"\n    },\n    \"first_name\": \"Ada\",\n    \"last_name\": \"Lovelace\",\n    \"website_url\": \"https://acme.com\"\n  },\n  \"customer_alias\": \"ext_39003209203023902\",\n  \"customer_id\": \"cust_abc123\",\n  \"expires_in_seconds\": 86400,\n  \"legal_entity_id\": \"le_01H1VECT\",\n  \"line_items\": [\n    {\n      \"description\": \"Implementation fee\",\n      \"quantity\": \"1\",\n      \"unit_price\": \"99.00\",\n      \"product_name\": \"Onboarding\"\n    }\n  ],\n  \"plan_id\": \"plan_01H1VECT\",\n  \"success_url\": \"https://example.com/welcome\"\n}"

response = http.request(request)
puts response.read_body

{
  "checkout_intent": "payment",
  "created_at": "2026-04-01T10:00:00Z",
  "currency": "USD",
  "id": "chks_01H1VECT",
  "session_token": "elt_01H1VECT",
  "status": "created",
  "url": "https://acme.alguna.io/embed/checkout/elt_01H1VECT",
  "amount": "99.00",
  "client_reference_id": "order_1234",
  "customer_id": "cust_abc123",
  "expires_at": "2026-04-02T10:00:00Z",
  "invoice_id": "inv_01H1VECT",
  "payment_id": "pay_01H1VECT",
  "subscription_id": "sub_01H1VECT"
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

Authorizations

Authorization

string

header

required

API key authentication. Pass your API key as a Bearer token.

Headers

Alguna-Version

enum<string>

required

Available options:

2026-04-01

Idempotency-Key

string

A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.

Maximum string length: 255

Example:

"ik_a1b2c3d4e5f6"

Body

application/json

amount

string | null

Total amount to charge when neither plan_id nor line_items are provided

Example:

"99.00"

checkout_intent

enum<string> | null

payment charges the customer; vault only collects and stores a payment method. Defaults to payment.

Available options:

payment,

vault

Example:

"payment"

client_reference_id

string | null

Your own reference for this checkout (order ID, cart ID). Echoed on the session and the checkoutsession.completed webhook.

Example:

"order_1234"

currency

string | null

ISO 4217 currency code; defaults to the organization currency

Example:

"USD"

customer

object | null

Details the customer account is created from when checkout completes. When neither this nor customer_id/customer_alias is provided, the embedded checkout collects them from the customer.

Show child attributes

customer_alias

string | null

Alternative identifier (external ID) for the customer. Used when customer_id is not provided.

Example:

"ext_39003209203023902"

customer_id

string | null

Customer the checkout is for. Omit for guest checkout and pass customer instead — the customer account is created when checkout completes.

Example:

"cust_abc123"

expires_in_seconds

integer<int64> | null

Session lifetime in seconds (5 minutes to 7 days). Defaults to 86400 (24 hours).

Example:

86400

legal_entity_id

string | null

Legal entity to bill from. Defaults to the customer's legal entity, falling back to the organization default.

Example:

"le_01H1VECT"

line_items

object[]

Ad-hoc line items to charge instead of a plan. Mutually exclusive with plan_id.

Show child attributes

plan_id

string | null

Plan to check out. The session's line items and amount are derived from the plan's prices. Mutually exclusive with line_items.

Example:

"plan_01H1VECT"

success_url

string | null

URL the customer can be sent to after a successful checkout

Example:

"https://example.com/welcome"

Response

Success

checkout_intent

enum<string>

required

Whether the session charges the customer or only stores a payment method

Available options:

payment,

vault

Example:

"payment"

created_at

string<date-time>

required

Timestamp when the session was created

Example:

"2026-04-01T10:00:00Z"

currency

string

required

ISO 4217 currency code

Example:

"USD"

string

required

Unique identifier for the checkout session

Example:

"chks_01H1VECT"

session_token

string

required

Browser-safe token that scopes the embedded checkout to this session. Pass it to the Alguna Checkout SDK.

Example:

"elt_01H1VECT"

status

enum<string>

required

Checkout session status

Available options:

created,

started,

successful,

expired

Example:

"created"

url

string

required

Hosted checkout URL for this session. The Alguna Checkout SDK embeds this URL; it can also be used directly as a redirect target.

Example:

"https://acme.alguna.io/embed/checkout/elt_01H1VECT"

amount

string | null

Total amount for the session

Example:

"99.00"

client_reference_id

string | null

Your reference supplied at creation

Example:

"order_1234"

customer_id

string | null

Customer the checkout is for, once known

Example:

"cust_abc123"

expires_at

string<date-time> | null

Timestamp when the session token expires

Example:

"2026-04-02T10:00:00Z"

invoice_id

string | null

Invoice created by the session, once completed. One-off sessions (line_items or amount) produce a paid invoice instead of a subscription.

Example:

"inv_01H1VECT"

payment_id

string | null

Payment created by the session, once completed

Example:

"pay_01H1VECT"

subscription_id

string | null

Subscription created by the session, once completed

Example:

"sub_01H1VECT"

⌘I

Create a checkout session

curl --request POST \
  --url https://api.alguna.io/checkout-sessions \
  --header 'Alguna-Version: <alguna-version>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "99.00",
  "checkout_intent": "payment",
  "client_reference_id": "order_1234",
  "currency": "USD",
  "customer": {
    "email": "billing@acme.com",
    "name": "Acme Corp",
    "address": {
      "city": "San Francisco",
      "country": "US",
      "line1": "123 Main St",
      "postal_code": "94105",
      "line2": "Suite 4",
      "state": "CA"
    },
    "first_name": "Ada",
    "last_name": "Lovelace",
    "website_url": "https://acme.com"
  },
  "customer_alias": "ext_39003209203023902",
  "customer_id": "cust_abc123",
  "expires_in_seconds": 86400,
  "legal_entity_id": "le_01H1VECT",
  "line_items": [
    {
      "description": "Implementation fee",
      "quantity": "1",
      "unit_price": "99.00",
      "product_name": "Onboarding"
    }
  ],
  "plan_id": "plan_01H1VECT",
  "success_url": "https://example.com/welcome"
}
'

import requests

url = "https://api.alguna.io/checkout-sessions"

payload = {
    "amount": "99.00",
    "checkout_intent": "payment",
    "client_reference_id": "order_1234",
    "currency": "USD",
    "customer": {
        "email": "billing@acme.com",
        "name": "Acme Corp",
        "address": {
            "city": "San Francisco",
            "country": "US",
            "line1": "123 Main St",
            "postal_code": "94105",
            "line2": "Suite 4",
            "state": "CA"
        },
        "first_name": "Ada",
        "last_name": "Lovelace",
        "website_url": "https://acme.com"
    },
    "customer_alias": "ext_39003209203023902",
    "customer_id": "cust_abc123",
    "expires_in_seconds": 86400,
    "legal_entity_id": "le_01H1VECT",
    "line_items": [
        {
            "description": "Implementation fee",
            "quantity": "1",
            "unit_price": "99.00",
            "product_name": "Onboarding"
        }
    ],
    "plan_id": "plan_01H1VECT",
    "success_url": "https://example.com/welcome"
}
headers = {
    "Alguna-Version": "<alguna-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Alguna-Version': '<alguna-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '99.00',
    checkout_intent: 'payment',
    client_reference_id: 'order_1234',
    currency: 'USD',
    customer: {
      email: 'billing@acme.com',
      name: 'Acme Corp',
      address: {
        city: 'San Francisco',
        country: 'US',
        line1: '123 Main St',
        postal_code: '94105',
        line2: 'Suite 4',
        state: 'CA'
      },
      first_name: 'Ada',
      last_name: 'Lovelace',
      website_url: 'https://acme.com'
    },
    customer_alias: 'ext_39003209203023902',
    customer_id: 'cust_abc123',
    expires_in_seconds: 86400,
    legal_entity_id: 'le_01H1VECT',
    line_items: [
      {
        description: 'Implementation fee',
        quantity: '1',
        unit_price: '99.00',
        product_name: 'Onboarding'
      }
    ],
    plan_id: 'plan_01H1VECT',
    success_url: 'https://example.com/welcome'
  })
};

fetch('https://api.alguna.io/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://api.alguna.io/checkout-sessions",
  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([
    'amount' => '99.00',
    'checkout_intent' => 'payment',
    'client_reference_id' => 'order_1234',
    'currency' => 'USD',
    'customer' => [
        'email' => 'billing@acme.com',
        'name' => 'Acme Corp',
        'address' => [
                'city' => 'San Francisco',
                'country' => 'US',
                'line1' => '123 Main St',
                'postal_code' => '94105',
                'line2' => 'Suite 4',
                'state' => 'CA'
        ],
        'first_name' => 'Ada',
        'last_name' => 'Lovelace',
        'website_url' => 'https://acme.com'
    ],
    'customer_alias' => 'ext_39003209203023902',
    'customer_id' => 'cust_abc123',
    'expires_in_seconds' => 86400,
    'legal_entity_id' => 'le_01H1VECT',
    'line_items' => [
        [
                'description' => 'Implementation fee',
                'quantity' => '1',
                'unit_price' => '99.00',
                'product_name' => 'Onboarding'
        ]
    ],
    'plan_id' => 'plan_01H1VECT',
    'success_url' => 'https://example.com/welcome'
  ]),
  CURLOPT_HTTPHEADER => [
    "Alguna-Version: <alguna-version>",
    "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://api.alguna.io/checkout-sessions"

	payload := strings.NewReader("{\n  \"amount\": \"99.00\",\n  \"checkout_intent\": \"payment\",\n  \"client_reference_id\": \"order_1234\",\n  \"currency\": \"USD\",\n  \"customer\": {\n    \"email\": \"billing@acme.com\",\n    \"name\": \"Acme Corp\",\n    \"address\": {\n      \"city\": \"San Francisco\",\n      \"country\": \"US\",\n      \"line1\": \"123 Main St\",\n      \"postal_code\": \"94105\",\n      \"line2\": \"Suite 4\",\n      \"state\": \"CA\"\n    },\n    \"first_name\": \"Ada\",\n    \"last_name\": \"Lovelace\",\n    \"website_url\": \"https://acme.com\"\n  },\n  \"customer_alias\": \"ext_39003209203023902\",\n  \"customer_id\": \"cust_abc123\",\n  \"expires_in_seconds\": 86400,\n  \"legal_entity_id\": \"le_01H1VECT\",\n  \"line_items\": [\n    {\n      \"description\": \"Implementation fee\",\n      \"quantity\": \"1\",\n      \"unit_price\": \"99.00\",\n      \"product_name\": \"Onboarding\"\n    }\n  ],\n  \"plan_id\": \"plan_01H1VECT\",\n  \"success_url\": \"https://example.com/welcome\"\n}")

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

	req.Header.Add("Alguna-Version", "<alguna-version>")
	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://api.alguna.io/checkout-sessions")
  .header("Alguna-Version", "<alguna-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"99.00\",\n  \"checkout_intent\": \"payment\",\n  \"client_reference_id\": \"order_1234\",\n  \"currency\": \"USD\",\n  \"customer\": {\n    \"email\": \"billing@acme.com\",\n    \"name\": \"Acme Corp\",\n    \"address\": {\n      \"city\": \"San Francisco\",\n      \"country\": \"US\",\n      \"line1\": \"123 Main St\",\n      \"postal_code\": \"94105\",\n      \"line2\": \"Suite 4\",\n      \"state\": \"CA\"\n    },\n    \"first_name\": \"Ada\",\n    \"last_name\": \"Lovelace\",\n    \"website_url\": \"https://acme.com\"\n  },\n  \"customer_alias\": \"ext_39003209203023902\",\n  \"customer_id\": \"cust_abc123\",\n  \"expires_in_seconds\": 86400,\n  \"legal_entity_id\": \"le_01H1VECT\",\n  \"line_items\": [\n    {\n      \"description\": \"Implementation fee\",\n      \"quantity\": \"1\",\n      \"unit_price\": \"99.00\",\n      \"product_name\": \"Onboarding\"\n    }\n  ],\n  \"plan_id\": \"plan_01H1VECT\",\n  \"success_url\": \"https://example.com/welcome\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alguna.io/checkout-sessions")

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

request = Net::HTTP::Post.new(url)
request["Alguna-Version"] = '<alguna-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"99.00\",\n  \"checkout_intent\": \"payment\",\n  \"client_reference_id\": \"order_1234\",\n  \"currency\": \"USD\",\n  \"customer\": {\n    \"email\": \"billing@acme.com\",\n    \"name\": \"Acme Corp\",\n    \"address\": {\n      \"city\": \"San Francisco\",\n      \"country\": \"US\",\n      \"line1\": \"123 Main St\",\n      \"postal_code\": \"94105\",\n      \"line2\": \"Suite 4\",\n      \"state\": \"CA\"\n    },\n    \"first_name\": \"Ada\",\n    \"last_name\": \"Lovelace\",\n    \"website_url\": \"https://acme.com\"\n  },\n  \"customer_alias\": \"ext_39003209203023902\",\n  \"customer_id\": \"cust_abc123\",\n  \"expires_in_seconds\": 86400,\n  \"legal_entity_id\": \"le_01H1VECT\",\n  \"line_items\": [\n    {\n      \"description\": \"Implementation fee\",\n      \"quantity\": \"1\",\n      \"unit_price\": \"99.00\",\n      \"product_name\": \"Onboarding\"\n    }\n  ],\n  \"plan_id\": \"plan_01H1VECT\",\n  \"success_url\": \"https://example.com/welcome\"\n}"

response = http.request(request)
puts response.read_body

{
  "checkout_intent": "payment",
  "created_at": "2026-04-01T10:00:00Z",
  "currency": "USD",
  "id": "chks_01H1VECT",
  "session_token": "elt_01H1VECT",
  "status": "created",
  "url": "https://acme.alguna.io/embed/checkout/elt_01H1VECT",
  "amount": "99.00",
  "client_reference_id": "order_1234",
  "customer_id": "cust_abc123",
  "expires_at": "2026-04-02T10:00:00Z",
  "invoice_id": "inv_01H1VECT",
  "payment_id": "pay_01H1VECT",
  "subscription_id": "sub_01H1VECT"
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

{
  "detail": "<string>",
  "status": 123
}

API Reference

Examples

API Reference

Create a checkout session

Authorizations

Headers

Body

Response