curl --request POST \
--url https://api.withflex.com/v1/payment_links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_link": {
"label": "Example",
"shipping_address_collection": false,
"shipping_options": {},
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"payment_intent_data": {},
"after_completion": {},
"allow_promotion_codes": false,
"origin": "shopify",
"tax_rate": {},
"mode": "payment",
"setup_future_use": "on_session"
}
}
'import requests
url = "https://api.withflex.com/v1/payment_links"
payload = { "payment_link": {
"label": "Example",
"shipping_address_collection": False,
"shipping_options": {},
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"payment_intent_data": {},
"after_completion": {},
"allow_promotion_codes": False,
"origin": "shopify",
"tax_rate": {},
"mode": "payment",
"setup_future_use": "on_session"
} }
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({
payment_link: {
label: 'Example',
shipping_address_collection: false,
shipping_options: {},
metadata: {order_id: '8842', channel: 'shopify'},
payment_intent_data: {},
after_completion: {},
allow_promotion_codes: false,
origin: 'shopify',
tax_rate: {},
mode: 'payment',
setup_future_use: 'on_session'
}
})
};
fetch('https://api.withflex.com/v1/payment_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.withflex.com/v1/payment_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([
'payment_link' => [
'label' => 'Example',
'shipping_address_collection' => false,
'shipping_options' => [
],
'metadata' => [
'order_id' => '8842',
'channel' => 'shopify'
],
'payment_intent_data' => [
],
'after_completion' => [
],
'allow_promotion_codes' => false,
'origin' => 'shopify',
'tax_rate' => [
],
'mode' => 'payment',
'setup_future_use' => 'on_session'
]
]),
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://api.withflex.com/v1/payment_links"
payload := strings.NewReader("{\n \"payment_link\": {\n \"label\": \"Example\",\n \"shipping_address_collection\": false,\n \"shipping_options\": {},\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"payment_intent_data\": {},\n \"after_completion\": {},\n \"allow_promotion_codes\": false,\n \"origin\": \"shopify\",\n \"tax_rate\": {},\n \"mode\": \"payment\",\n \"setup_future_use\": \"on_session\"\n }\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://api.withflex.com/v1/payment_links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payment_link\": {\n \"label\": \"Example\",\n \"shipping_address_collection\": false,\n \"shipping_options\": {},\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"payment_intent_data\": {},\n \"after_completion\": {},\n \"allow_promotion_codes\": false,\n \"origin\": \"shopify\",\n \"tax_rate\": {},\n \"mode\": \"payment\",\n \"setup_future_use\": \"on_session\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withflex.com/v1/payment_links")
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 \"payment_link\": {\n \"label\": \"Example\",\n \"shipping_address_collection\": false,\n \"shipping_options\": {},\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"payment_intent_data\": {},\n \"after_completion\": {},\n \"allow_promotion_codes\": false,\n \"origin\": \"shopify\",\n \"tax_rate\": {},\n \"mode\": \"payment\",\n \"setup_future_use\": \"on_session\"\n }\n}"
response = http.request(request)
puts response.read_body{
"payment_link": {
"payment_link_id": "fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"label": "Example",
"active": false,
"allow_promotion_codes": false,
"shipping_address_collection": false,
"shipping_options": {},
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"url": "https://example.com",
"created_at": "2026-06-15T14:30:00Z",
"payment_intent_data": {},
"after_completion": {},
"origin": "shopify",
"tax_rate": {},
"setup_future_use": "on_session",
"test_mode": false
}
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}{
"code": "string",
"detail": "string"
}Create Payment Link
Creates a payment link: a shareable URL that generates a checkout session each time a customer
opens it. The mode is determined by line_items — it becomes subscription if any price is
recurring, otherwise payment; pass mode=setup to save a payment method without a charge
(setup mode requires a label and empty line_items). Creating a link may create supporting
objects as a side effect: inline price_data provisions a Product and Price (in Stripe and
Flex), inline shipping rate data creates a Shipping Rate, and inline coupon_data discounts
create Coupons. Promotion codes are not accepted as discounts here — use coupon IDs or inline
coupon data.
curl --request POST \
--url https://api.withflex.com/v1/payment_links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payment_link": {
"label": "Example",
"shipping_address_collection": false,
"shipping_options": {},
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"payment_intent_data": {},
"after_completion": {},
"allow_promotion_codes": false,
"origin": "shopify",
"tax_rate": {},
"mode": "payment",
"setup_future_use": "on_session"
}
}
'import requests
url = "https://api.withflex.com/v1/payment_links"
payload = { "payment_link": {
"label": "Example",
"shipping_address_collection": False,
"shipping_options": {},
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"payment_intent_data": {},
"after_completion": {},
"allow_promotion_codes": False,
"origin": "shopify",
"tax_rate": {},
"mode": "payment",
"setup_future_use": "on_session"
} }
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({
payment_link: {
label: 'Example',
shipping_address_collection: false,
shipping_options: {},
metadata: {order_id: '8842', channel: 'shopify'},
payment_intent_data: {},
after_completion: {},
allow_promotion_codes: false,
origin: 'shopify',
tax_rate: {},
mode: 'payment',
setup_future_use: 'on_session'
}
})
};
fetch('https://api.withflex.com/v1/payment_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.withflex.com/v1/payment_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([
'payment_link' => [
'label' => 'Example',
'shipping_address_collection' => false,
'shipping_options' => [
],
'metadata' => [
'order_id' => '8842',
'channel' => 'shopify'
],
'payment_intent_data' => [
],
'after_completion' => [
],
'allow_promotion_codes' => false,
'origin' => 'shopify',
'tax_rate' => [
],
'mode' => 'payment',
'setup_future_use' => 'on_session'
]
]),
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://api.withflex.com/v1/payment_links"
payload := strings.NewReader("{\n \"payment_link\": {\n \"label\": \"Example\",\n \"shipping_address_collection\": false,\n \"shipping_options\": {},\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"payment_intent_data\": {},\n \"after_completion\": {},\n \"allow_promotion_codes\": false,\n \"origin\": \"shopify\",\n \"tax_rate\": {},\n \"mode\": \"payment\",\n \"setup_future_use\": \"on_session\"\n }\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://api.withflex.com/v1/payment_links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payment_link\": {\n \"label\": \"Example\",\n \"shipping_address_collection\": false,\n \"shipping_options\": {},\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"payment_intent_data\": {},\n \"after_completion\": {},\n \"allow_promotion_codes\": false,\n \"origin\": \"shopify\",\n \"tax_rate\": {},\n \"mode\": \"payment\",\n \"setup_future_use\": \"on_session\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withflex.com/v1/payment_links")
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 \"payment_link\": {\n \"label\": \"Example\",\n \"shipping_address_collection\": false,\n \"shipping_options\": {},\n \"metadata\": {\n \"order_id\": \"8842\",\n \"channel\": \"shopify\"\n },\n \"payment_intent_data\": {},\n \"after_completion\": {},\n \"allow_promotion_codes\": false,\n \"origin\": \"shopify\",\n \"tax_rate\": {},\n \"mode\": \"payment\",\n \"setup_future_use\": \"on_session\"\n }\n}"
response = http.request(request)
puts response.read_body{
"payment_link": {
"payment_link_id": "fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"label": "Example",
"active": false,
"allow_promotion_codes": false,
"shipping_address_collection": false,
"shipping_options": {},
"metadata": {
"order_id": "8842",
"channel": "shopify"
},
"url": "https://example.com",
"created_at": "2026-06-15T14:30:00Z",
"payment_intent_data": {},
"after_completion": {},
"origin": "shopify",
"tax_rate": {},
"setup_future_use": "on_session",
"test_mode": false
}
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"code": "string",
"detail": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}{
"code": "string",
"detail": "string"
}Authorizations
Use a Bearer token to access this API.
Body
An envelope wrapping a single payment link object.
An envelope wrapping a single payment link object.
The payment link.
Show child attributes
Show child attributes
{
"label": "Example",
"shipping_address_collection": false,
"shipping_options": {
"shipping_rate_id": "fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
},
"metadata": { "order_id": "8842", "channel": "shopify" },
"payment_intent_data": {
"capture_method": "automatic",
"metadata": { "order_id": "8842", "channel": "shopify" }
},
"after_completion": { "type": "redirect" },
"allow_promotion_codes": false,
"origin": "shopify",
"tax_rate": { "amount": 2500 },
"mode": "payment",
"setup_future_use": "on_session"
}
Response
An envelope wrapping a single payment link object.
An envelope wrapping a single payment link object.
The payment link.
Show child attributes
Show child attributes
{
"payment_link_id": "fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"label": "Example",
"active": false,
"allow_promotion_codes": false,
"shipping_address_collection": false,
"shipping_options": {
"shipping_rate_id": "fshr_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
"shipping_amount": 2500,
"display_name": "Example"
},
"metadata": { "order_id": "8842", "channel": "shopify" },
"url": "https://example.com",
"created_at": "2026-06-15T14:30:00Z",
"payment_intent_data": {
"capture_method": "automatic",
"metadata": { "order_id": "8842", "channel": "shopify" }
},
"after_completion": {
"type": "redirect",
"hosted_confirmation": {},
"redirect": {}
},
"origin": "shopify",
"tax_rate": { "amount": 2500 },
"setup_future_use": "on_session",
"test_mode": false
}