Skip to main content
PATCH
/
v1
/
checkout-links
/
{id}
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.Update(ctx, "<value>", components.CheckoutLinkUpdate{})
    if err != nil {
        log.Fatal(err)
    }
    if res.CheckoutLink != nil {
        switch res.CheckoutLink.Discount.Type {
            case components.CheckoutLinkDiscountTypeDiscountFixedOnceForeverDurationBase:
                // res.CheckoutLink.Discount.DiscountFixedOnceForeverDurationBase is populated
            case components.CheckoutLinkDiscountTypeDiscountFixedRepeatDurationBase:
                // res.CheckoutLink.Discount.DiscountFixedRepeatDurationBase is populated
            case components.CheckoutLinkDiscountTypeDiscountPercentageOnceForeverDurationBase:
                // res.CheckoutLink.Discount.DiscountPercentageOnceForeverDurationBase is populated
            case components.CheckoutLinkDiscountTypeDiscountPercentageRepeatDurationBase:
                // res.CheckoutLink.Discount.DiscountPercentageRepeatDurationBase is populated
        }

    }
}
{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "trial_interval_count": 123,
  "metadata": {},
  "payment_processor": "stripe",
  "client_secret": "<string>",
  "success_url": "<string>",
  "return_url": "<string>",
  "label": "<string>",
  "allow_discount_codes": true,
  "require_billing_address": true,
  "discount_id": "<string>",
  "seats": 123,
  "organization_id": "<string>",
  "products": [
    {
      "metadata": {},
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "trial_interval_count": 123,
      "name": "<string>",
      "description": "<string>",
      "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>",
          "amount_type": "<string>",
          "price_currency": "<string>",
          "is_archived": true,
          "product_id": "<string>",
          "type": "<string>",
          "price_amount": 123,
          "legacy": true
        }
      ],
      "benefits": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "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": "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": {
    "amount": 123,
    "currency": "<string>",
    "amounts": {},
    "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": "<string>"
  },
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

​
id
string<uuid4>
required

The checkout link ID.

Body

application/json

Schema to update an existing checkout link.

​
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
​
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.

​
products
string<uuid4>[] | null

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

Minimum array length: 1
​
label
string | null
​
allow_discount_codes
boolean | null

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 | null

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 <= 1000
​
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 updated.

Checkout link data.

​
id
string<uuid4>
required

The ID of the object.

​
created_at
string<date-time>
required

Creation timestamp of the object.

​
modified_at
string<date-time> | null
required

Last modification timestamp of the object.

​
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
​
payment_processor
enum<string>
required

Payment processor used.

Available options:
stripe
​
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

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.

​
organization_id
string<uuid4>
required

The organization ID.

Example:

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

​
products
CheckoutLinkProduct · object[]
required
​
discount
DiscountFixedOnceForeverDurationBase · object
required
​
url
string
required