Create Checkout Link

POST

checkout-links

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.checkout_links.create(
    payment_processor='stripe',
    allow_discount_codes=True,
    require_billing_address=False,
    products=['00000000-0000-4000-8000-000000000000'],
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.checkoutLinks.create(
  {
    "payment_processor": "stripe",
    "allow_discount_codes": true,
    "require_billing_address": false,
    "products": [
      "00000000-0000-4000-8000-000000000000"
    ]
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/checkout-links/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_processor": "stripe",
  "products": [
    "<string>"
  ],
  "metadata": {},
  "trial_interval_count": 500,
  "trial_payment_setup_required": true,
  "label": "<string>",
  "allow_discount_codes": true,
  "require_billing_address": false,
  "discount_id": "<string>",
  "seats": 5000,
  "units": 1073741824,
  "success_url": "<string>",
  "return_url": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payment_processor: 'stripe',
    products: ['<string>'],
    metadata: {},
    trial_interval_count: 500,
    trial_payment_setup_required: true,
    label: '<string>',
    allow_discount_codes: true,
    require_billing_address: false,
    discount_id: '<string>',
    seats: 5000,
    units: 1073741824,
    success_url: '<string>',
    return_url: '<string>'
  })
};

fetch('https://api.polar.sh/v1/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.polar.sh/v1/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([
    'payment_processor' => 'stripe',
    'products' => [
        '<string>'
    ],
    'metadata' => [
        
    ],
    'trial_interval_count' => 500,
    'trial_payment_setup_required' => true,
    'label' => '<string>',
    'allow_discount_codes' => true,
    'require_billing_address' => false,
    'discount_id' => '<string>',
    'seats' => 5000,
    'units' => 1073741824,
    'success_url' => '<string>',
    'return_url' => '<string>'
  ]),
  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.polar.sh/v1/checkout-links/"

	payload := strings.NewReader("{\n  \"payment_processor\": \"stripe\",\n  \"products\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"trial_payment_setup_required\": true,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"units\": 1073741824,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\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.polar.sh/v1/checkout-links/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_processor\": \"stripe\",\n  \"products\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"trial_payment_setup_required\": true,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"units\": 1073741824,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/checkout-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_processor\": \"stripe\",\n  \"products\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"trial_payment_setup_required\": true,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"units\": 1073741824,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "trial_interval": "day",
  "trial_interval_count": 123,
  "metadata": {},
  "payment_processor": "stripe",
  "trial_payment_setup_required": true,
  "client_secret": "<string>",
  "success_url": "<string>",
  "return_url": "<string>",
  "label": "<string>",
  "allow_discount_codes": true,
  "require_billing_address": true,
  "discount_id": "<string>",
  "seats": 123,
  "units": 123,
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "products": [
    {
      "metadata": {},
      "id": "<string>",
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "trial_interval": "day",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "visibility": "draft",
      "recurring_interval": "day",
      "recurring_interval_count": 123,
      "meter_interval": "day",
      "meter_interval_count": 123,
      "is_recurring": true,
      "is_archived": true,
      "organization_id": "<string>",
      "prices": [
        {
          "created_at": "2026-01-01T00:00:00.000000Z",
          "modified_at": "2026-01-01T00:00:00.000000Z",
          "id": "<string>",
          "source": "catalog",
          "amount_type": "fixed",
          "price_currency": "<string>",
          "tax_behavior": "location",
          "is_archived": true,
          "product_id": "<string>",
          "price_amount": 123
        }
      ],
      "benefits": [
        {
          "id": "<string>",
          "created_at": "2026-01-01T00:00:00.000000Z",
          "modified_at": "2026-01-01T00:00:00.000000Z",
          "type": "custom",
          "description": "<string>",
          "selectable": true,
          "deletable": true,
          "is_deleted": true,
          "organization_id": "<string>"
        }
      ],
      "medias": [
        {
          "id": "<string>",
          "organization_id": "<string>",
          "name": "<string>",
          "path": "<string>",
          "mime_type": "<string>",
          "size": 123,
          "storage_version": "<string>",
          "checksum_etag": "<string>",
          "checksum_sha256_base64": "<string>",
          "checksum_sha256_hex": "<string>",
          "last_modified_at": "2026-01-01T00:00:00.000000Z",
          "version": "<string>",
          "service": "product_media",
          "is_uploaded": true,
          "created_at": "2026-01-01T00:00:00.000000Z",
          "size_readable": "<string>",
          "public_url": "<string>"
        }
      ]
    }
  ],
  "discount": {
    "duration": "once",
    "type": "fixed",
    "amounts": {
      "eur": 900,
      "usd": 1000
    },
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "id": "<string>",
    "external_id": "ext_1337",
    "metadata": {},
    "name": "<string>",
    "code": "<string>",
    "starts_at": "2026-01-01T00:00:00.000000Z",
    "ends_at": "2026-01-01T00:00:00.000000Z",
    "max_redemptions": 123,
    "max_redemptions_per_customer": 123,
    "redemptions_count": 123,
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
  },
  "url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Looking to create a single use checkout session? Checkout Links are probably not what you’re looking for.Checkout Links are shareable links that generate checkout sessions when opened. They are very handy to start a purchase from your website or social media.However, if you want to start a checkout for one of your user inside your product, you should use the Checkout Sessions API.

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Scopes

checkout_links:write

pat

checkout_links:write

oat

Body

application/json

Schema to create a new checkout link.

payment_processor

string

required

Payment processor to use. Currently only Stripe is supported.

Allowed value: "stripe"

products

string<uuid4>[]

required

List of products that will be available to select at checkout.

Minimum array length: 1

metadata

Metadata · object

Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

A string with a maximum length of 500 characters
An integer
A floating-point number
A boolean

You can store up to 50 key-value pairs.

Show child attributes

trial_interval

enum<string> | null

The interval unit for the trial period.

Available options:

day,

week,

month,

year

trial_interval_count

integer | null

The number of interval units for the trial period.

Required range: 1 <= x <= 1000

trial_payment_setup_required

boolean | null

Whether customers must provide a payment method to start a trial. If false, customers can start a trial without entering payment details. If null, the product's setting is used.

label

string | null

Optional label to distinguish links internally

allow_discount_codes

boolean

default:true

Whether to allow the customer to apply discount codes. If you apply a discount through discount_id, it'll still be applied, but the customer won't be able to change it.

require_billing_address

boolean

default:false

Whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.

discount_id

string<uuid4> | null

ID of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.

seats

integer | null

Preconfigured number of seats for seat-based pricing. When set, checkout sessions created from this link are locked to this number of seats and the customer won't be able to change it. All products on the link must use seat-based pricing and allow this number of seats. If the products no longer accommodate this value when the link is opened, it'll be ignored.

Required range: 1 <= x <= 10000

units

integer | null

Preconfigured number of units for unit-based pricing. When set, checkout sessions created from this link are locked to this number of units and the customer won't be able to change it. All products on the link must use unit-based pricing and allow this number of units. If the products no longer accommodate this value when the link is opened, it'll be ignored.

Required range: 1 <= x <= 2147483647

success_url

string<uri> | null

URL where the customer will be redirected after a successful payment.You can add the checkout_id={CHECKOUT_ID} query parameter to retrieve the checkout session id.

Required string length: 1 - 2083

return_url

string<uri> | null

When set, a back button will be shown in the checkout to return to this URL.

Required string length: 1 - 2083

Response

Checkout link created.

Checkout link data.

string<uuid4>

required

The ID of the object.

created_at

string<date-time>

required

Creation timestamp of the object.

Example:

"2026-01-01T00:00:00.000000Z"

modified_at

string<date-time> | null

required

Last modification timestamp of the object.

Example:

"2026-01-01T00:00:00.000000Z"

trial_interval

enum<string> | null

required

The interval unit for the trial period.

Available options:

day,

week,

month,

year

trial_interval_count

integer | null

required

The number of interval units for the trial period.

metadata

object

required

Show child attributes

payment_processor

enum<string>

required

Payment processor used.

Available options:

stripe

trial_payment_setup_required

boolean | null

required

Whether customers must provide a payment method to start a trial. If false, customers can start a trial without entering payment details. If null, the product's setting is used.

client_secret

string

required

Client secret used to access the checkout link.

success_url

string | null

required

URL where the customer will be redirected after a successful payment.

return_url

string | null

required

When set, a back button will be shown in the checkout to return to this URL.

label

string | null

required

Optional label to distinguish links internally

allow_discount_codes

boolean

required

Whether to allow the customer to apply discount codes. If you apply a discount through discount_id, it'll still be applied, but the customer won't be able to change it.

require_billing_address

boolean

required

Whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.

discount_id

string<uuid4> | null

required

ID of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.

seats

integer | null

required

units

integer | null

required

organization_id

string<uuid4>

required

The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

products

CheckoutLinkProduct · object[]

required

Show child attributes

discount

DiscountFixedOnceForeverDurationBase · object

required

DiscountFixedOnceForeverDurationBase
DiscountFixedRepeatDurationBase
DiscountPercentageOnceForeverDurationBase
DiscountPercentageRepeatDurationBase

Show child attributes

url

string

required

read-only

⌘I

Python

from polar.v2027_01 import Polar

polar = Polar("polar_oat_xxx")

response = polar.checkout_links.create(
    payment_processor='stripe',
    allow_discount_codes=True,
    require_billing_address=False,
    products=['00000000-0000-4000-8000-000000000000'],
)
print(response)

import { createPolar } from "@polar-sh/sdk/2027-01";

const polar = createPolar({
  accessToken: "polar_oat_xxx",
});

const response = await polar.checkoutLinks.create(
  {
    "payment_processor": "stripe",
    "allow_discount_codes": true,
    "require_billing_address": false,
    "products": [
      "00000000-0000-4000-8000-000000000000"
    ]
  },
);
console.log(response);

curl --request POST \
  --url https://api.polar.sh/v1/checkout-links/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_processor": "stripe",
  "products": [
    "<string>"
  ],
  "metadata": {},
  "trial_interval_count": 500,
  "trial_payment_setup_required": true,
  "label": "<string>",
  "allow_discount_codes": true,
  "require_billing_address": false,
  "discount_id": "<string>",
  "seats": 5000,
  "units": 1073741824,
  "success_url": "<string>",
  "return_url": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payment_processor: 'stripe',
    products: ['<string>'],
    metadata: {},
    trial_interval_count: 500,
    trial_payment_setup_required: true,
    label: '<string>',
    allow_discount_codes: true,
    require_billing_address: false,
    discount_id: '<string>',
    seats: 5000,
    units: 1073741824,
    success_url: '<string>',
    return_url: '<string>'
  })
};

fetch('https://api.polar.sh/v1/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.polar.sh/v1/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([
    'payment_processor' => 'stripe',
    'products' => [
        '<string>'
    ],
    'metadata' => [
        
    ],
    'trial_interval_count' => 500,
    'trial_payment_setup_required' => true,
    'label' => '<string>',
    'allow_discount_codes' => true,
    'require_billing_address' => false,
    'discount_id' => '<string>',
    'seats' => 5000,
    'units' => 1073741824,
    'success_url' => '<string>',
    'return_url' => '<string>'
  ]),
  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.polar.sh/v1/checkout-links/"

	payload := strings.NewReader("{\n  \"payment_processor\": \"stripe\",\n  \"products\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"trial_payment_setup_required\": true,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"units\": 1073741824,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\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.polar.sh/v1/checkout-links/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_processor\": \"stripe\",\n  \"products\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"trial_payment_setup_required\": true,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"units\": 1073741824,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.polar.sh/v1/checkout-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_processor\": \"stripe\",\n  \"products\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"trial_interval_count\": 500,\n  \"trial_payment_setup_required\": true,\n  \"label\": \"<string>\",\n  \"allow_discount_codes\": true,\n  \"require_billing_address\": false,\n  \"discount_id\": \"<string>\",\n  \"seats\": 5000,\n  \"units\": 1073741824,\n  \"success_url\": \"<string>\",\n  \"return_url\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "created_at": "2026-01-01T00:00:00.000000Z",
  "modified_at": "2026-01-01T00:00:00.000000Z",
  "trial_interval": "day",
  "trial_interval_count": 123,
  "metadata": {},
  "payment_processor": "stripe",
  "trial_payment_setup_required": true,
  "client_secret": "<string>",
  "success_url": "<string>",
  "return_url": "<string>",
  "label": "<string>",
  "allow_discount_codes": true,
  "require_billing_address": true,
  "discount_id": "<string>",
  "seats": 123,
  "units": 123,
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "products": [
    {
      "metadata": {},
      "id": "<string>",
      "created_at": "2026-01-01T00:00:00.000000Z",
      "modified_at": "2026-01-01T00:00:00.000000Z",
      "trial_interval": "day",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "visibility": "draft",
      "recurring_interval": "day",
      "recurring_interval_count": 123,
      "meter_interval": "day",
      "meter_interval_count": 123,
      "is_recurring": true,
      "is_archived": true,
      "organization_id": "<string>",
      "prices": [
        {
          "created_at": "2026-01-01T00:00:00.000000Z",
          "modified_at": "2026-01-01T00:00:00.000000Z",
          "id": "<string>",
          "source": "catalog",
          "amount_type": "fixed",
          "price_currency": "<string>",
          "tax_behavior": "location",
          "is_archived": true,
          "product_id": "<string>",
          "price_amount": 123
        }
      ],
      "benefits": [
        {
          "id": "<string>",
          "created_at": "2026-01-01T00:00:00.000000Z",
          "modified_at": "2026-01-01T00:00:00.000000Z",
          "type": "custom",
          "description": "<string>",
          "selectable": true,
          "deletable": true,
          "is_deleted": true,
          "organization_id": "<string>"
        }
      ],
      "medias": [
        {
          "id": "<string>",
          "organization_id": "<string>",
          "name": "<string>",
          "path": "<string>",
          "mime_type": "<string>",
          "size": 123,
          "storage_version": "<string>",
          "checksum_etag": "<string>",
          "checksum_sha256_base64": "<string>",
          "checksum_sha256_hex": "<string>",
          "last_modified_at": "2026-01-01T00:00:00.000000Z",
          "version": "<string>",
          "service": "product_media",
          "is_uploaded": true,
          "created_at": "2026-01-01T00:00:00.000000Z",
          "size_readable": "<string>",
          "public_url": "<string>"
        }
      ]
    }
  ],
  "discount": {
    "duration": "once",
    "type": "fixed",
    "amounts": {
      "eur": 900,
      "usd": 1000
    },
    "created_at": "2026-01-01T00:00:00.000000Z",
    "modified_at": "2026-01-01T00:00:00.000000Z",
    "id": "<string>",
    "external_id": "ext_1337",
    "metadata": {},
    "name": "<string>",
    "code": "<string>",
    "starts_at": "2026-01-01T00:00:00.000000Z",
    "ends_at": "2026-01-01T00:00:00.000000Z",
    "max_redemptions": 123,
    "max_redemptions_per_customer": 123,
    "redemptions_count": 123,
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
  },
  "url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

General

Core API

Customer Portal API

Webhook Events

Integrations

Create Checkout Link

Authorizations

Scopes

Body

Response