Issue Funding Endpoints

External Organizations

Repositories

Other Endpoints

Advertisements

Benefits

Checkout-Links

Checkouts

Custom-Fields

Customer Portal

Files

Metrics

Oauth2

Orders

Subscriptions

checkouts

Get Checkout Session

get
/v1/checkouts/custom/{id}
Get a checkout session by ID.

Authentication

Methods
OpenID Connect
Personal Access Token
Subjects
Organization
User
Scopes
checkouts:read
checkouts:write

Parameters

idpath Parameteruuid4Required
The checkout session ID.

Responses

Successful Response
created_atdate-time
Creation timestamp of the object.
modified_at
date-time|null
Last modification timestamp of the object.
iduuid4
The ID of the object.
custom_field_dataCustom Field Data
Key-value object storing custom field values.
payment_processor"stripe"
Payment processor used.
status"open" | "expired" | "confirmed" | "succeeded" | "failed"
Status of the checkout session.
client_secretstring
Client secret used to update and complete the checkout session from the client.
urlstring
URL where the customer can access the checkout session.
expires_atdate-time
Expiration date and time of the checkout session.
success_urlstring
URL where the customer will be redirected after a successful payment.
embed_origin
string|null
When checkout is embedded, represents the Origin of the page embedding the checkout. Used as a security measure to send messages only to the embedding page.
amount
integer|null
tax_amount
integer|null
Computed tax amount to pay in cents.
currency
string|null
Currency code of the checkout session.
subtotal_amount
integer|null
Subtotal amount in cents, including discounts and before tax.
total_amount
integer|null
Total amount to pay in cents, including discounts and after tax.
product_iduuid4
ID of the product to checkout.
product_price_iduuid4
ID of the product price to checkout.
discount_id
uuid4|null
ID of the discount applied to the checkout.
allow_discount_codesboolean
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.
is_discount_applicableboolean
Whether the discount is applicable to the checkout. Typically, free and custom prices are not discountable.
is_free_product_priceboolean
Whether the product price is free, regardless of discounts.
is_payment_requiredboolean
Whether the checkout requires payment, e.g. in case of free products or discounts that cover the total amount.
is_payment_setup_requiredboolean
Whether the checkout requires setting up a payment method, regardless of the amount, e.g. subscriptions that have first free cycles.
is_payment_form_requiredboolean
Whether the checkout requires a payment form, whether because of a payment or payment method setup.
customer_id
uuid4|null
customer_name
string|null
customer_email
string|null
customer_ip_address
string|null
customer_billing_address
Address|null
customer_tax_id
string|null
payment_processor_metadataPayment Processor Metadata
metadataMetadata
productCheckoutProduct
Product data for a checkout session.
created_atdate-time
Creation timestamp of the object.
modified_at
date-time|null
Last modification timestamp of the object.
iduuid4
The ID of the product.
namestring
The name of the product.
description
string|null
The description of the product.
is_recurringboolean
Whether the product is a subscription tier.
is_archivedboolean
Whether the product is archived and no longer available.
organization_iduuid4
The ID of the organization owning the product.
prices
(
ProductPriceRecurringFixed|ProductPriceRecurringCustom|ProductPriceRecurringFree
|
ProductPriceOneTimeFixed|ProductPriceOneTimeCustom|ProductPriceOneTimeFree
)[]
List of prices for this product.
benefits
BenefitBase[]
List of benefits granted by the product.
created_atdate-time
Creation timestamp of the object.
modified_at
date-time|null
Last modification timestamp of the object.
iduuid4
The ID of the benefit.
type"custom" | "ads" | "discord" | "github_repository" | "downloadables" | "license_keys"
The type of the benefit.
descriptionstring
The description of the benefit.
selectableboolean
Whether the benefit is selectable when creating a product.
deletableboolean
Whether the benefit is deletable.
organization_iduuid4
The ID of the organization owning the benefit.
medias
ProductMediaFileRead[]
List of medias associated to the product.
iduuid4
The ID of the object.
organization_iduuid4
namestring
pathstring
mime_typestring
sizeinteger
storage_version
string|null
checksum_etag
string|null
checksum_sha256_base64
string|null
checksum_sha256_hex
string|null
last_modified_at
date-time|null
version
string|null
service"product_media"
is_uploadedboolean
created_atdate-time
size_readablestring
public_urlstring
product_price
ProductPriceRecurringFixed|ProductPriceRecurringCustom|ProductPriceRecurringFree
|
ProductPriceOneTimeFixed|ProductPriceOneTimeCustom|ProductPriceOneTimeFree
discount
CheckoutDiscountFixedOnceForeverDuration|CheckoutDiscountFixedRepeatDuration|CheckoutDiscountPercentageOnceForeverDuration|CheckoutDiscountPercentageRepeatDuration
|null
subscription_id
uuid4|null
attached_custom_fields
AttachedCustomField[]
custom_field_iduuid4
ID of the custom field.
custom_field
CustomFieldText|CustomFieldNumber|CustomFieldDate|CustomFieldCheckbox|CustomFieldSelect
orderinteger
Order of the custom field in the resource.
requiredboolean
Whether the value is required for this custom field.
customer_metadataCustomer Metadata
curl -X GET \
    'https://api.polar.sh/v1/checkouts/custom/00000000-0000-0000-0000-000000000000' \
    -H "Accept: application/json" \
    -H "Authorization: Bearer <token>" \
    
Responses
{
  "created_at": "2025-01-02T00:00:00.000Z",
  "modified_at": "2025-01-02T00:00:00.000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "custom_field_data": {},
  "payment_processor": "stripe",
  "status": "open",
  "client_secret": "string",
  "url": "string",
  "expires_at": "2025-01-02T00:00:00.000Z",
  "success_url": "string",
  "embed_origin": "string",
  "amount": 0,
  "tax_amount": 0,
  "currency": "string",
  "subtotal_amount": 0,
  "total_amount": 0,
  "product_id": "00000000-0000-0000-0000-000000000000",
  "product_price_id": "00000000-0000-0000-0000-000000000000",
  "discount_id": "00000000-0000-0000-0000-000000000000",
  "allow_discount_codes": false,
  "is_discount_applicable": false,
  "is_free_product_price": false,
  "is_payment_required": false,
  "is_payment_setup_required": false,
  "is_payment_form_required": false,
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "customer_name": "string",
  "customer_email": "string",
  "customer_ip_address": "string",
  "customer_billing_address": {
    "line1": "string",
    "line2": "string",
    "postal_code": "string",
    "city": "string",
    "state": "string",
    "country": "string"
  },
  "customer_tax_id": "string",
  "payment_processor_metadata": {},
  "metadata": {},
  "product": {
    "created_at": "2025-01-02T00:00:00.000Z",
    "modified_at": "2025-01-02T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string",
    "is_recurring": false,
    "is_archived": false,
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "prices": [
      {
        "created_at": "2025-01-02T00:00:00.000Z",
        "modified_at": "2025-01-02T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "amount_type": "fixed",
        "is_archived": false,
        "product_id": "00000000-0000-0000-0000-000000000000",
        "price_currency": "string",
        "price_amount": 0,
        "type": "recurring",
        "recurring_interval": "month"
      }
    ],
    "benefits": [
      {
        "created_at": "2025-01-02T00:00:00.000Z",
        "modified_at": "2025-01-02T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "custom",
        "description": "string",
        "selectable": false,
        "deletable": false,
        "organization_id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "medias": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "path": "string",
        "mime_type": "string",
        "size": 0,
        "storage_version": "string",
        "checksum_etag": "string",
        "checksum_sha256_base64": "string",
        "checksum_sha256_hex": "string",
        "last_modified_at": "2025-01-02T00:00:00.000Z",
        "version": "string",
        "service": "product_media",
        "is_uploaded": false,
        "created_at": "2025-01-02T00:00:00.000Z",
        "size_readable": "string",
        "public_url": "string"
      }
    ]
  },
  "product_price": {
    "created_at": "2025-01-02T00:00:00.000Z",
    "modified_at": "2025-01-02T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "amount_type": "fixed",
    "is_archived": false,
    "product_id": "00000000-0000-0000-0000-000000000000",
    "price_currency": "string",
    "price_amount": 0,
    "type": "recurring",
    "recurring_interval": "month"
  },
  "discount": {
    "duration": "once",
    "type": "fixed",
    "amount": 0,
    "currency": "string",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "code": "string"
  },
  "subscription_id": "00000000-0000-0000-0000-000000000000",
  "attached_custom_fields": [
    {
      "custom_field_id": "00000000-0000-0000-0000-000000000000",
      "custom_field": {
        "created_at": "2025-01-02T00:00:00.000Z",
        "modified_at": "2025-01-02T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "metadata": {},
        "type": "text",
        "slug": "string",
        "name": "string",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "properties": {
          "form_label": "string",
          "form_help_text": "string",
          "form_placeholder": "string",
          "textarea": false,
          "min_length": 0,
          "max_length": 0
        }
      },
      "order": 0,
      "required": false
    }
  ],
  "customer_metadata": {}
}

We use tracking cookies to understand how you use the product and help us improve it.