Checkout links

Create a studio-scoped guest checkout link

Requires checkout_links:write and print_orders:write plus access to the explicit studio. Anonymous sessions cannot use this management lane. The credential persists the sandbox or production checkout lane: a br_test_ key creates an explicitly sandboxed, non-payable link with preview_status=non_payable and no URL; an explicitly production link is payable, subject to normal guest-checkout policy and payment readiness. A historical missing-lane staff or guardian link remains compatibility-payable only when it has no machine API-key provenance. A missing-lane machine link fails closed. Live creation returns share_url only for the first successful create response. Reusing an idempotency key with a different request fingerprint returns checkout_link_conflict.

POST

studios

{studio_id}

checkout-links

Create a studio-scoped guest checkout link

curl --request POST \
  --url https://api.batchrelay.com/v1/studios/{studio_id}/checkout-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "event_id": "<string>",
  "recipient": {
    "athlete_event_entry_id": "<string>",
    "guardian_id": "<string>"
  },
  "sellable": {
    "id": "<string>",
    "quantity": 50,
    "digital_configuration_id": "<string>",
    "prepared_asset_assignment_ids": [
      "<string>"
    ],
    "variant_id": "<string>"
  },
  "customizable": false,
  "expires_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.batchrelay.com/v1/studios/{studio_id}/checkout-links"

payload = {
    "event_id": "<string>",
    "recipient": {
        "athlete_event_entry_id": "<string>",
        "guardian_id": "<string>"
    },
    "sellable": {
        "id": "<string>",
        "quantity": 50,
        "digital_configuration_id": "<string>",
        "prepared_asset_assignment_ids": ["<string>"],
        "variant_id": "<string>"
    },
    "customizable": False,
    "expires_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    event_id: '<string>',
    recipient: {athlete_event_entry_id: '<string>', guardian_id: '<string>'},
    sellable: {
      id: '<string>',
      quantity: 50,
      digital_configuration_id: '<string>',
      prepared_asset_assignment_ids: ['<string>'],
      variant_id: '<string>'
    },
    customizable: false,
    expires_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.batchrelay.com/v1/studios/{studio_id}/checkout-links', 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.batchrelay.com/v1/studios/{studio_id}/checkout-links",
  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([
    'event_id' => '<string>',
    'recipient' => [
        'athlete_event_entry_id' => '<string>',
        'guardian_id' => '<string>'
    ],
    'sellable' => [
        'id' => '<string>',
        'quantity' => 50,
        'digital_configuration_id' => '<string>',
        'prepared_asset_assignment_ids' => [
                '<string>'
        ],
        'variant_id' => '<string>'
    ],
    'customizable' => false,
    'expires_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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.batchrelay.com/v1/studios/{studio_id}/checkout-links"

	payload := strings.NewReader("{\n  \"event_id\": \"<string>\",\n  \"recipient\": {\n    \"athlete_event_entry_id\": \"<string>\",\n    \"guardian_id\": \"<string>\"\n  },\n  \"sellable\": {\n    \"id\": \"<string>\",\n    \"quantity\": 50,\n    \"digital_configuration_id\": \"<string>\",\n    \"prepared_asset_assignment_ids\": [\n      \"<string>\"\n    ],\n    \"variant_id\": \"<string>\"\n  },\n  \"customizable\": false,\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.batchrelay.com/v1/studios/{studio_id}/checkout-links")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_id\": \"<string>\",\n  \"recipient\": {\n    \"athlete_event_entry_id\": \"<string>\",\n    \"guardian_id\": \"<string>\"\n  },\n  \"sellable\": {\n    \"id\": \"<string>\",\n    \"quantity\": 50,\n    \"digital_configuration_id\": \"<string>\",\n    \"prepared_asset_assignment_ids\": [\n      \"<string>\"\n    ],\n    \"variant_id\": \"<string>\"\n  },\n  \"customizable\": false,\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/checkout-links")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_id\": \"<string>\",\n  \"recipient\": {\n    \"athlete_event_entry_id\": \"<string>\",\n    \"guardian_id\": \"<string>\"\n  },\n  \"sellable\": {\n    \"id\": \"<string>\",\n    \"quantity\": 50,\n    \"digital_configuration_id\": \"<string>\",\n    \"prepared_asset_assignment_ids\": [\n      \"<string>\"\n    ],\n    \"variant_id\": \"<string>\"\n  },\n  \"customizable\": false,\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "revocable": true,
  "status": "active",
  "preview_status": "non_payable",
  "share_url": "<string>",
  "subtotal_cents": 1
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization

string

header

required

Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.

Headers

Idempotency-Key

string

required

Required string length: 1 - 200

X-BatchRelay-Client-Surface

string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

X-BatchRelay-Client-Version

string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

X-BatchRelay-Invocation-Mode

string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

studio_id

string

required

Stable public studio ID beginning with stu_. The API never selects a studio implicitly; a local CLI profile name is not a studio ID.

Required string length: 5 - 256

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

Body

application/json

The server resolves current published retail pricing and freezes the non-customizable quote. Client price, tax, payment, provider, recipient-contact, and token fields are not accepted.

event_id

string

required

Required string length: 1 - 240

recipient

object

required

Show child attributes

sellable

object

required

Show child attributes

customizable

boolean

default:false

expires_at

string<date-time>

Must be in the future and no later than seven days after creation.

Response

Created or idempotently replayed checkout link. An explicitly sandboxed creation includes preview_status=non_payable and no URL; an explicitly production creation is payable and returns share_url only once for a new Live Mode link.

Safe lifecycle projection. It deliberately excludes the token, recipient context, retail-line details, Stripe identifiers, and provider data.

expires_at

string<date-time>

required

string

required

revocable

boolean

required

status

enum<string>

required

Available options:

active,

checkout_created,

fulfilled,

revoked,

expired

preview_status

string

Present only in a Test Mode creation response. It is an explicit non-payable result, not a browser URL or checkout capability.

Allowed value: "non_payable"

Live Mode bearer URL, returned only once in the first successful creation response. Treat as a secret.

subtotal_cents

integer

Required range: x >= 0

Create a studio-scoped guest checkout link

curl --request POST \
  --url https://api.batchrelay.com/v1/studios/{studio_id}/checkout-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "event_id": "<string>",
  "recipient": {
    "athlete_event_entry_id": "<string>",
    "guardian_id": "<string>"
  },
  "sellable": {
    "id": "<string>",
    "quantity": 50,
    "digital_configuration_id": "<string>",
    "prepared_asset_assignment_ids": [
      "<string>"
    ],
    "variant_id": "<string>"
  },
  "customizable": false,
  "expires_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.batchrelay.com/v1/studios/{studio_id}/checkout-links"

payload = {
    "event_id": "<string>",
    "recipient": {
        "athlete_event_entry_id": "<string>",
        "guardian_id": "<string>"
    },
    "sellable": {
        "id": "<string>",
        "quantity": 50,
        "digital_configuration_id": "<string>",
        "prepared_asset_assignment_ids": ["<string>"],
        "variant_id": "<string>"
    },
    "customizable": False,
    "expires_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    event_id: '<string>',
    recipient: {athlete_event_entry_id: '<string>', guardian_id: '<string>'},
    sellable: {
      id: '<string>',
      quantity: 50,
      digital_configuration_id: '<string>',
      prepared_asset_assignment_ids: ['<string>'],
      variant_id: '<string>'
    },
    customizable: false,
    expires_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.batchrelay.com/v1/studios/{studio_id}/checkout-links', 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.batchrelay.com/v1/studios/{studio_id}/checkout-links",
  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([
    'event_id' => '<string>',
    'recipient' => [
        'athlete_event_entry_id' => '<string>',
        'guardian_id' => '<string>'
    ],
    'sellable' => [
        'id' => '<string>',
        'quantity' => 50,
        'digital_configuration_id' => '<string>',
        'prepared_asset_assignment_ids' => [
                '<string>'
        ],
        'variant_id' => '<string>'
    ],
    'customizable' => false,
    'expires_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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.batchrelay.com/v1/studios/{studio_id}/checkout-links"

	payload := strings.NewReader("{\n  \"event_id\": \"<string>\",\n  \"recipient\": {\n    \"athlete_event_entry_id\": \"<string>\",\n    \"guardian_id\": \"<string>\"\n  },\n  \"sellable\": {\n    \"id\": \"<string>\",\n    \"quantity\": 50,\n    \"digital_configuration_id\": \"<string>\",\n    \"prepared_asset_assignment_ids\": [\n      \"<string>\"\n    ],\n    \"variant_id\": \"<string>\"\n  },\n  \"customizable\": false,\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.batchrelay.com/v1/studios/{studio_id}/checkout-links")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_id\": \"<string>\",\n  \"recipient\": {\n    \"athlete_event_entry_id\": \"<string>\",\n    \"guardian_id\": \"<string>\"\n  },\n  \"sellable\": {\n    \"id\": \"<string>\",\n    \"quantity\": 50,\n    \"digital_configuration_id\": \"<string>\",\n    \"prepared_asset_assignment_ids\": [\n      \"<string>\"\n    ],\n    \"variant_id\": \"<string>\"\n  },\n  \"customizable\": false,\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/checkout-links")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_id\": \"<string>\",\n  \"recipient\": {\n    \"athlete_event_entry_id\": \"<string>\",\n    \"guardian_id\": \"<string>\"\n  },\n  \"sellable\": {\n    \"id\": \"<string>\",\n    \"quantity\": 50,\n    \"digital_configuration_id\": \"<string>\",\n    \"prepared_asset_assignment_ids\": [\n      \"<string>\"\n    ],\n    \"variant_id\": \"<string>\"\n  },\n  \"customizable\": false,\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "revocable": true,
  "status": "active",
  "preview_status": "non_payable",
  "share_url": "<string>",
  "subtotal_cents": 1
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

{
  "code": "<string>",
  "docs_url": "<string>",
  "error": "<string>",
  "message": "<string>",
  "request_id": "<string>"
}

System

Authentication

Anonymous sessions

API accounts

API keys

Managed assets

Browser previews

Catalog

Event team changes

Studio management

Print orders

Template renders

Studio assets

Studio audit

Asset sessions

Assets

Studio catalog assets

Checkout links

Image imports

Studio messages

Studio catalog

Sandbox promotions

Storefront

Templates

Create a studio-scoped guest checkout link

Authorizations

Headers

Path Parameters

Body

Response