List Checkout Links

GET

checkout-links

Go (SDK)

package main

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

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

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

    res, err := s.CheckoutLinks.List(ctx, operations.CheckoutLinksListRequest{
        OrganizationID: polargo.Pointer(operations.CreateCheckoutLinksListQueryParamOrganizationIDFilterStr(
            "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        )),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceCheckoutLink != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "items": [
    {
      "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": "<string>",
      "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": 123,
        "currency": "<string>",
        "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>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

organization_id

Filter by organization ID.

Example:

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

product_id

Filter by product ID.

page

integer

default:1

Page number, defaults to 1.

limit

integer

default:10

Size of a page, defaults to 10. Maximum is 100.

sorting

enum<string>[] | null

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Available options:

created_at,

-created_at,

label,

-label,

success_url,

-success_url,

allow_discount_codes,

-allow_discount_codes

Response

Successful Response

items

CheckoutLink · object[]

required

Show child attributes

items.id

string<uuid4>

required

The ID of the object.

items.created_at

string<date-time>

required

Creation timestamp of the object.

items.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

items.trial_interval

enum<string> | null

required

The interval unit for the trial period.

Available options:

day,

week,

month,

year

items.trial_interval_count

integer | null

required

The number of interval units for the trial period.

items.metadata

Metadata · object

required

Show child attributes

items.metadata.{key}

items.payment_processor

enum<string>

required

Payment processor used.

Available options:

stripe

items.client_secret

string

required

Client secret used to access the checkout link.

items.success_url

string | null

required

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

items.label

string | null

required

Optional label to distinguish links internally

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

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

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

items.organization_id

string<uuid4>

required

The organization ID.

items.products

CheckoutLinkProduct · object[]

required

Show child attributes

items.products.metadata

Metadata · object

required

Show child attributes

items.products.metadata.{key}

items.products.id

string<uuid4>

required

The ID of the object.

items.products.created_at

string<date-time>

required

Creation timestamp of the object.

items.products.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

items.products.trial_interval

enum<string> | null

required

The interval unit for the trial period.

Available options:

day,

week,

month,

year

items.products.trial_interval_count

integer | null

required

The number of interval units for the trial period.

items.products.name

string

required

The name of the product.

items.products.description

string | null

required

The description of the product.

items.products.recurring_interval

enum<string> | null

required

The recurring interval of the product. If None, the product is a one-time purchase.

Available options:

day,

week,

month,

year

items.products.recurring_interval_count

integer | null

required

Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.

items.products.is_recurring

boolean

required

Whether the product is a subscription.

items.products.is_archived

boolean

required

Whether the product is archived and no longer available.

items.products.organization_id

string<uuid4>

required

The ID of the organization owning the product.

items.products.prices

required

List of prices for this product.

A recurring price for a product, i.e. a subscription.

Deprecated: The recurring interval should be set on the product itself.

LegacyRecurringProductPriceFixed
LegacyRecurringProductPriceCustom
LegacyRecurringProductPriceFree
ProductPriceFixed
ProductPriceCustom
ProductPriceFree
ProductPriceSeatBased
ProductPriceMeteredUnit

Show child attributes

items.products.prices.created_at

string<date-time>

required

Creation timestamp of the object.

items.products.prices.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

items.products.prices.id

string<uuid4>

required

The ID of the price.

items.products.prices.source

enum<string>

required

The source of the price . catalog is a predefined price, while ad_hoc is a price created dynamically on a Checkout session.

Available options:

catalog,

ad_hoc

items.products.prices.amount_type

string

required

Allowed value: "fixed"

items.products.prices.is_archived

boolean

required

Whether the price is archived and no longer available.

items.products.prices.product_id

string<uuid4>

required

The ID of the product owning the price.

items.products.prices.type

string

required

The type of the price.

Allowed value: "recurring"

items.products.prices.recurring_interval

enum<string>

required

The recurring interval of the price.

Available options:

day,

week,

month,

year

items.products.prices.price_currency

string

required

The currency.

items.products.prices.price_amount

integer

required

The price in cents.

items.products.prices.legacy

boolean

required

items.products.benefits

BenefitPublic · object[]

required

List of benefits granted by the product.

Show child attributes

items.products.benefits.id

string<uuid4>

required

The ID of the benefit.

items.products.benefits.created_at

string<date-time>

required

Creation timestamp of the object.

items.products.benefits.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

items.products.benefits.type

enum<string>

required

The type of the benefit.

Available options:

custom,

discord,

github_repository,

downloadables,

license_keys,

meter_credit

items.products.benefits.description

string

required

The description of the benefit.

items.products.benefits.selectable

boolean

required

Whether the benefit is selectable when creating a product.

items.products.benefits.deletable

boolean

required

Whether the benefit is deletable.

items.products.benefits.organization_id

string<uuid4>

required

The ID of the organization owning the benefit.

items.products.medias

ProductMediaFileRead · object[]

required

List of medias associated to the product.

Show child attributes

items.products.medias.id

string<uuid4>

required

The ID of the object.

items.products.medias.organization_id

string<uuid4>

required

items.products.medias.name

string

required

items.products.medias.path

string

required

items.products.medias.mime_type

string

required

items.products.medias.size

integer

required

items.products.medias.storage_version

string | null

required

items.products.medias.checksum_etag

string | null

required

items.products.medias.checksum_sha256_base64

string | null

required

items.products.medias.checksum_sha256_hex

string | null

required

items.products.medias.last_modified_at

string<date-time> | null

required

items.products.medias.version

string | null

required

items.products.medias.service

string

required

Allowed value: "product_media"

items.products.medias.is_uploaded

boolean

required

items.products.medias.created_at

string<date-time>

required

items.products.medias.size_readable

string

required

items.products.medias.public_url

string

required

items.discount

DiscountFixedOnceForeverDurationBase · object

required

DiscountFixedOnceForeverDurationBase
DiscountFixedRepeatDurationBase
DiscountPercentageOnceForeverDurationBase
DiscountPercentageRepeatDurationBase

Show child attributes

items.discount.duration

enum<string>

required

Available options:

once,

forever,

repeating

items.discount.type

enum<string>

required

Available options:

fixed,

percentage

items.discount.amount

integer

required

items.discount.currency

string

required

items.discount.created_at

string<date-time>

required

Creation timestamp of the object.

items.discount.modified_at

string<date-time> | null

required

Last modification timestamp of the object.

items.discount.id

string<uuid4>

required

The ID of the object.

items.discount.metadata

Metadata · object

required

Show child attributes

items.discount.metadata.{key}

items.discount.name

string

required

Name of the discount. Will be displayed to the customer when the discount is applied.

items.discount.code

string | null

required

Code customers can use to apply the discount during checkout.

items.discount.starts_at

string<date-time> | null

required

Timestamp after which the discount is redeemable.

items.discount.ends_at

string<date-time> | null

required

Timestamp after which the discount is no longer redeemable.

items.discount.max_redemptions

integer | null

required

Maximum number of times the discount can be redeemed.

items.discount.redemptions_count

integer

required

Number of times the discount has been redeemed.

items.discount.organization_id

string<uuid4>

required

The organization ID.

items.url

string

required

pagination

Pagination · object

required

Show child attributes

pagination.total_count

integer

required

pagination.max_page

integer

required

Update Checkout LinkUpdate a checkout link. **Scopes**: `checkout_links:write`

⌘I

Go (SDK)

package main

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

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

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

    res, err := s.CheckoutLinks.List(ctx, operations.CheckoutLinksListRequest{
        OrganizationID: polargo.Pointer(operations.CreateCheckoutLinksListQueryParamOrganizationIDFilterStr(
            "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        )),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceCheckoutLink != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "items": [
    {
      "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": "<string>",
      "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": 123,
        "currency": "<string>",
        "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>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

General

Core API

Customer Portal API

Webhook Events

Integrations

List Checkout Links

Authorizations

Query Parameters

Response