Checkouts
Create a new checkout session
Initializes a new Blink checkout session for a product and returns the checkout url and session id. Supports pre-filling and locking the buyer email (customer_email + lock_email: true), attaching arbitrary JSON (custom_data), applying discounts or affiliate codes, and dynamic redirect URL placeholders ({CHECKOUT_SESSION_ID}, {ORDER_ID}, {SUBSCRIPTION_ID}, {PAYMENT_INTENT_ID}).
POST
/
checkouts
Create a new checkout session
curl --request POST \
--url https://api.blink.store/v1/checkouts \
--header 'Content-Type: application/json' \
--data '
{
"product_id": "<string>",
"variant_id": "<string>",
"customer_email": "<string>",
"discount_code": "<string>",
"affiliate_code": "<string>",
"splits": [
{}
],
"success_url": "<string>",
"cancel_url": "<string>",
"ui_mode": "<string>",
"return_url": "<string>",
"metadata": {},
"custom_data": {},
"seat_quantity": 123,
"options": {
"hide_carousel": true,
"hide_title": true,
"hide_discount": true,
"hide_refund": true,
"hide_support": true,
"show_desc": true,
"show_preview": true,
"button_text": "<string>",
"locale": "<string>",
"product_name": "<string>",
"custom_fields": [
{}
],
"lock_email": false
},
"custom_checkout_id": "<string>",
"lock_email": false
}
'import requests
url = "https://api.blink.store/v1/checkouts"
payload = {
"product_id": "<string>",
"variant_id": "<string>",
"customer_email": "<string>",
"discount_code": "<string>",
"affiliate_code": "<string>",
"splits": [{}],
"success_url": "<string>",
"cancel_url": "<string>",
"ui_mode": "<string>",
"return_url": "<string>",
"metadata": {},
"custom_data": {},
"seat_quantity": 123,
"options": {
"hide_carousel": True,
"hide_title": True,
"hide_discount": True,
"hide_refund": True,
"hide_support": True,
"show_desc": True,
"show_preview": True,
"button_text": "<string>",
"locale": "<string>",
"product_name": "<string>",
"custom_fields": [{}],
"lock_email": False
},
"custom_checkout_id": "<string>",
"lock_email": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
product_id: '<string>',
variant_id: '<string>',
customer_email: '<string>',
discount_code: '<string>',
affiliate_code: '<string>',
splits: [{}],
success_url: '<string>',
cancel_url: '<string>',
ui_mode: '<string>',
return_url: '<string>',
metadata: {},
custom_data: {},
seat_quantity: 123,
options: {
hide_carousel: true,
hide_title: true,
hide_discount: true,
hide_refund: true,
hide_support: true,
show_desc: true,
show_preview: true,
button_text: '<string>',
locale: '<string>',
product_name: '<string>',
custom_fields: [{}],
lock_email: false
},
custom_checkout_id: '<string>',
lock_email: false
})
};
fetch('https://api.blink.store/v1/checkouts', 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.blink.store/v1/checkouts",
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([
'product_id' => '<string>',
'variant_id' => '<string>',
'customer_email' => '<string>',
'discount_code' => '<string>',
'affiliate_code' => '<string>',
'splits' => [
[
]
],
'success_url' => '<string>',
'cancel_url' => '<string>',
'ui_mode' => '<string>',
'return_url' => '<string>',
'metadata' => [
],
'custom_data' => [
],
'seat_quantity' => 123,
'options' => [
'hide_carousel' => true,
'hide_title' => true,
'hide_discount' => true,
'hide_refund' => true,
'hide_support' => true,
'show_desc' => true,
'show_preview' => true,
'button_text' => '<string>',
'locale' => '<string>',
'product_name' => '<string>',
'custom_fields' => [
[
]
],
'lock_email' => false
],
'custom_checkout_id' => '<string>',
'lock_email' => false
]),
CURLOPT_HTTPHEADER => [
"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.blink.store/v1/checkouts"
payload := strings.NewReader("{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": [\n {}\n ],\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"ui_mode\": \"<string>\",\n \"return_url\": \"<string>\",\n \"metadata\": {},\n \"custom_data\": {},\n \"seat_quantity\": 123,\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"show_preview\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ],\n \"lock_email\": false\n },\n \"custom_checkout_id\": \"<string>\",\n \"lock_email\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
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.blink.store/v1/checkouts")
.header("Content-Type", "application/json")
.body("{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": [\n {}\n ],\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"ui_mode\": \"<string>\",\n \"return_url\": \"<string>\",\n \"metadata\": {},\n \"custom_data\": {},\n \"seat_quantity\": 123,\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"show_preview\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ],\n \"lock_email\": false\n },\n \"custom_checkout_id\": \"<string>\",\n \"lock_email\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blink.store/v1/checkouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": [\n {}\n ],\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"ui_mode\": \"<string>\",\n \"return_url\": \"<string>\",\n \"metadata\": {},\n \"custom_data\": {},\n \"seat_quantity\": 123,\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"show_preview\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ],\n \"lock_email\": false\n },\n \"custom_checkout_id\": \"<string>\",\n \"lock_email\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"url": "<string>",
"status": "open",
"product_id": "<string>",
"variant_id": "<string>",
"amount": 123,
"currency": "usd",
"is_test": true,
"custom_data": {}
}
}Body
application/json
UUID of the product to purchase.
Optional UUID of the specific product variant.
Pre-fill the buyer email address on the checkout form.
URL to redirect the buyer to after a successful payment. Supports dynamic placeholders: {CHECKOUT_SESSION_ID} (or {CHECKOUT_ID}), {ORDER_ID}, {SUBSCRIPTION_ID}, and {PAYMENT_INTENT_ID}.
Fallback redirect URL (alias for success_url / cancel_url). Supports {CHECKOUT_SESSION_ID}, {ORDER_ID}, {SUBSCRIPTION_ID}, and {PAYMENT_INTENT_ID}.
Optional key-value metadata object. If custom_data is omitted, metadata is automatically used as custom_data.
Arbitrary JSON object to attach to the checkout session (e.g., {"user_id": "usr_123"}). Persisted onto the resulting Order and Subscription (custom_data) and echoed back verbatim at data.custom_data in checkout.created, order.created, order.paid, and all subscription.* webhooks.
Pre-filled seat quantity
Show child attributes
Show child attributes
UUID of the custom checkout design
When true (and customer_email is provided), locks the email input on the checkout page so the buyer cannot modify it.
Response
Checkout session created
Show child attributes
Show child attributes
⌘I
Create a new checkout session
curl --request POST \
--url https://api.blink.store/v1/checkouts \
--header 'Content-Type: application/json' \
--data '
{
"product_id": "<string>",
"variant_id": "<string>",
"customer_email": "<string>",
"discount_code": "<string>",
"affiliate_code": "<string>",
"splits": [
{}
],
"success_url": "<string>",
"cancel_url": "<string>",
"ui_mode": "<string>",
"return_url": "<string>",
"metadata": {},
"custom_data": {},
"seat_quantity": 123,
"options": {
"hide_carousel": true,
"hide_title": true,
"hide_discount": true,
"hide_refund": true,
"hide_support": true,
"show_desc": true,
"show_preview": true,
"button_text": "<string>",
"locale": "<string>",
"product_name": "<string>",
"custom_fields": [
{}
],
"lock_email": false
},
"custom_checkout_id": "<string>",
"lock_email": false
}
'import requests
url = "https://api.blink.store/v1/checkouts"
payload = {
"product_id": "<string>",
"variant_id": "<string>",
"customer_email": "<string>",
"discount_code": "<string>",
"affiliate_code": "<string>",
"splits": [{}],
"success_url": "<string>",
"cancel_url": "<string>",
"ui_mode": "<string>",
"return_url": "<string>",
"metadata": {},
"custom_data": {},
"seat_quantity": 123,
"options": {
"hide_carousel": True,
"hide_title": True,
"hide_discount": True,
"hide_refund": True,
"hide_support": True,
"show_desc": True,
"show_preview": True,
"button_text": "<string>",
"locale": "<string>",
"product_name": "<string>",
"custom_fields": [{}],
"lock_email": False
},
"custom_checkout_id": "<string>",
"lock_email": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
product_id: '<string>',
variant_id: '<string>',
customer_email: '<string>',
discount_code: '<string>',
affiliate_code: '<string>',
splits: [{}],
success_url: '<string>',
cancel_url: '<string>',
ui_mode: '<string>',
return_url: '<string>',
metadata: {},
custom_data: {},
seat_quantity: 123,
options: {
hide_carousel: true,
hide_title: true,
hide_discount: true,
hide_refund: true,
hide_support: true,
show_desc: true,
show_preview: true,
button_text: '<string>',
locale: '<string>',
product_name: '<string>',
custom_fields: [{}],
lock_email: false
},
custom_checkout_id: '<string>',
lock_email: false
})
};
fetch('https://api.blink.store/v1/checkouts', 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.blink.store/v1/checkouts",
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([
'product_id' => '<string>',
'variant_id' => '<string>',
'customer_email' => '<string>',
'discount_code' => '<string>',
'affiliate_code' => '<string>',
'splits' => [
[
]
],
'success_url' => '<string>',
'cancel_url' => '<string>',
'ui_mode' => '<string>',
'return_url' => '<string>',
'metadata' => [
],
'custom_data' => [
],
'seat_quantity' => 123,
'options' => [
'hide_carousel' => true,
'hide_title' => true,
'hide_discount' => true,
'hide_refund' => true,
'hide_support' => true,
'show_desc' => true,
'show_preview' => true,
'button_text' => '<string>',
'locale' => '<string>',
'product_name' => '<string>',
'custom_fields' => [
[
]
],
'lock_email' => false
],
'custom_checkout_id' => '<string>',
'lock_email' => false
]),
CURLOPT_HTTPHEADER => [
"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.blink.store/v1/checkouts"
payload := strings.NewReader("{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": [\n {}\n ],\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"ui_mode\": \"<string>\",\n \"return_url\": \"<string>\",\n \"metadata\": {},\n \"custom_data\": {},\n \"seat_quantity\": 123,\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"show_preview\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ],\n \"lock_email\": false\n },\n \"custom_checkout_id\": \"<string>\",\n \"lock_email\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
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.blink.store/v1/checkouts")
.header("Content-Type", "application/json")
.body("{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": [\n {}\n ],\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"ui_mode\": \"<string>\",\n \"return_url\": \"<string>\",\n \"metadata\": {},\n \"custom_data\": {},\n \"seat_quantity\": 123,\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"show_preview\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ],\n \"lock_email\": false\n },\n \"custom_checkout_id\": \"<string>\",\n \"lock_email\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blink.store/v1/checkouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"product_id\": \"<string>\",\n \"variant_id\": \"<string>\",\n \"customer_email\": \"<string>\",\n \"discount_code\": \"<string>\",\n \"affiliate_code\": \"<string>\",\n \"splits\": [\n {}\n ],\n \"success_url\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"ui_mode\": \"<string>\",\n \"return_url\": \"<string>\",\n \"metadata\": {},\n \"custom_data\": {},\n \"seat_quantity\": 123,\n \"options\": {\n \"hide_carousel\": true,\n \"hide_title\": true,\n \"hide_discount\": true,\n \"hide_refund\": true,\n \"hide_support\": true,\n \"show_desc\": true,\n \"show_preview\": true,\n \"button_text\": \"<string>\",\n \"locale\": \"<string>\",\n \"product_name\": \"<string>\",\n \"custom_fields\": [\n {}\n ],\n \"lock_email\": false\n },\n \"custom_checkout_id\": \"<string>\",\n \"lock_email\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"url": "<string>",
"status": "open",
"product_id": "<string>",
"variant_id": "<string>",
"amount": 123,
"currency": "usd",
"is_test": true,
"custom_data": {}
}
}