Skip to main content
GET
/
v1
/
checkouts
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.Checkouts.List(ctx, operations.CheckoutsListRequest{
        OrganizationID: polargo.Pointer(operations.CreateCheckoutsListQueryParamOrganizationIDFilterStr(
            "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
        )),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceCheckout != 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",
      "payment_processor": "stripe",
      "status": "open",
      "client_secret": "<string>",
      "url": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "success_url": "<string>",
      "return_url": "<string>",
      "embed_origin": "<string>",
      "amount": 123,
      "discount_amount": 123,
      "net_amount": 123,
      "tax_amount": 123,
      "tax_behavior": "inclusive",
      "total_amount": 123,
      "currency": "<string>",
      "allow_trial": true,
      "active_trial_interval": "day",
      "active_trial_interval_count": 123,
      "trial_end": "2023-11-07T05:31:56Z",
      "organization_id": "<string>",
      "product_id": "<string>",
      "product_price_id": "<string>",
      "discount_id": "<string>",
      "allow_discount_codes": true,
      "require_billing_address": true,
      "is_discount_applicable": true,
      "is_free_product_price": true,
      "is_payment_required": true,
      "is_payment_setup_required": true,
      "is_payment_form_required": true,
      "customer_id": "<string>",
      "is_business_customer": true,
      "customer_name": "<string>",
      "customer_email": "<string>",
      "customer_ip_address": "<string>",
      "customer_billing_name": "<string>",
      "customer_billing_address": {
        "country": "AD",
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>"
      },
      "customer_tax_id": "<string>",
      "payment_processor_metadata": {},
      "billing_address_fields": {
        "country": "required",
        "state": "required",
        "city": "required",
        "postal_code": "required",
        "line1": "required",
        "line2": "required"
      },
      "trial_interval": "day",
      "trial_interval_count": 123,
      "metadata": {},
      "external_customer_id": "<string>",
      "products": [
        {
          "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>",
          "visibility": "draft",
          "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>",
              "price_currency": "<string>",
              "tax_behavior": "location",
              "is_archived": true,
              "product_id": "<string>",
              "type": "<string>",
              "recurring_interval": "day",
              "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,
              "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>"
            }
          ]
        }
      ],
      "product": {
        "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>",
        "visibility": "draft",
        "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>",
            "price_currency": "<string>",
            "tax_behavior": "location",
            "is_archived": true,
            "product_id": "<string>",
            "type": "<string>",
            "recurring_interval": "day",
            "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,
            "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>"
          }
        ]
      },
      "product_price": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "source": "catalog",
        "amount_type": "<string>",
        "price_currency": "<string>",
        "tax_behavior": "location",
        "is_archived": true,
        "product_id": "<string>",
        "type": "<string>",
        "recurring_interval": "day",
        "price_amount": 123,
        "legacy": true
      },
      "prices": {},
      "discount": {
        "duration": "once",
        "type": "fixed",
        "amount": 123,
        "currency": "<string>",
        "amounts": {},
        "id": "<string>",
        "name": "<string>",
        "code": "<string>"
      },
      "subscription_id": "<string>",
      "attached_custom_fields": [
        {
          "custom_field_id": "<string>",
          "custom_field": {
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "metadata": {},
            "type": "<string>",
            "slug": "<string>",
            "name": "<string>",
            "organization_id": "<string>",
            "properties": {
              "form_label": "<string>",
              "form_help_text": "<string>",
              "form_placeholder": "<string>",
              "textarea": true,
              "min_length": 1073741823,
              "max_length": 1073741823
            }
          },
          "order": 123,
          "required": true
        }
      ],
      "customer_metadata": {},
      "custom_field_data": {},
      "seats": 123,
      "min_seats": 123,
      "max_seats": 123,
      "locale": "<string>"
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://polar.sh/docs/llms.txt

Use this file to discover all available pages before exploring further.

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. The organization ID.

Example:

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

​
product_id

Filter by product ID. The product ID.

​
customer_id

Filter by customer ID. The customer ID.

​
external_customer_id

Filter by customer external ID. The customer external ID.

​
status

Filter by checkout session status.

Available options:
open,
expired,
confirmed,
succeeded,
failed
​
query
string | null

Filter by customer email.

​
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,
expires_at,
-expires_at,
status,
-status

Response

Successful Response

​
items
Checkout · object[]
required
​
pagination
Pagination · object
required