Skip to main content
POST
/
v1
/
checkout-links
/
Go (SDK)
package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.CheckoutLinks.Create(ctx, components.CreateCheckoutLinkCreateCheckoutLinkCreateProductPrice(
        components.CheckoutLinkCreateProductPrice{
            ProductPriceID: "<value>",
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.CheckoutLink != nil {
        // handle response
    }
}
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "trial_interval": "day",
  "trial_interval_count": 123,
  "metadata": {},
  "payment_processor": "stripe",
  "client_secret": "<string>",
  "success_url": "<string>",
  "label": "<string>",
  "allow_discount_codes": true,
  "require_billing_address": true,
  "discount_id": "<string>",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "products": [
    {
      "metadata": {},
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "trial_interval": "day",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "recurring_interval": "day",
      "recurring_interval_count": 123,
      "is_recurring": true,
      "is_archived": true,
      "organization_id": "<string>",
      "prices": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "source": "catalog",
          "amount_type": "<string>",
          "is_archived": true,
          "product_id": "<string>",
          "type": "<string>",
          "recurring_interval": "day",
          "price_currency": "<string>",
          "price_amount": 123,
          "legacy": true
        }
      ],
      "benefits": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "type": "custom",
          "description": "<string>",
          "selectable": true,
          "deletable": 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": "2023-11-07T05:31:56Z",
          "version": "<string>",
          "service": "<string>",
          "is_uploaded": true,
          "created_at": "2023-11-07T05:31:56Z",
          "size_readable": "<string>",
          "public_url": "<string>"
        }
      ]
    }
  ],
  "discount": {
    "duration": "once",
    "type": "fixed",
    "amount": 1000,
    "currency": "usd",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "metadata": {},
    "name": "<string>",
    "code": "<string>",
    "starts_at": "2023-11-07T05:31:56Z",
    "ends_at": "2023-11-07T05:31:56Z",
    "max_redemptions": 123,
    "redemptions_count": 123,
    "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"
  },
  "url": "<string>"
}
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

Body

application/json
  • CheckoutLinkCreateProductPrice
  • CheckoutLinkCreateProduct
  • CheckoutLinkCreateProducts
​
payment_processor
string
required
Allowed value: "stripe"
​
product_price_id
string<uuid4>
required
​
metadata
object
​
trial_interval
enum<string> | null
Available options:
day,
week,
month,
year
​
trial_interval_count
integer | null
Required range: 1 <= x <= 1000
​
label
string | null
​
allow_discount_codes
boolean
default:true
​
require_billing_address
boolean
default:false
​
discount_id
string<uuid4> | null
​
success_url
string<uri> | null
Required string length: 1 - 2083

Response

​
id
string<uuid4>
required
​
created_at
string<date-time>
required
​
modified_at
string<date-time> | null
required
​
trial_interval
enum<string> | null
required
Available options:
day,
week,
month,
year
​
trial_interval_count
integer | null
required
​
metadata
object
required
​
payment_processor
enum<string>
required
Available options:
stripe
​
client_secret
string
required
​
success_url
string | null
required
​
label
string | null
required
​
allow_discount_codes
boolean
required
​
require_billing_address
boolean
required
​
discount_id
string<uuid4> | null
required
​
organization_id
string<uuid4>
required
Examples:
​
products
CheckoutLinkProduct · object[]
required
​
discount
object | null
required
  • DiscountFixedOnceForeverDurationBase
  • DiscountFixedRepeatDurationBase
  • DiscountPercentageOnceForeverDurationBase
  • DiscountPercentageRepeatDurationBase
​
url
string
required