Documentation

Developers

IntroductionAuthentication

Featured Endpoints

Checkouts

List Checkout SessionsGET
Create Checkout SessionPOST
Get Checkout SessionGET
Update Checkout SessionPATCH
Get Checkout Session from ClientGET
Update Checkout Session from ClientPATCH
Confirm Checkout Session from ClientPOST

Customer Portal

Customer-Sessions

Customers

Discounts

License Keys

Oauth2

Organizations

Products

Issue Funding Endpoints

External Organizations

Repositories

Other Endpoints

Advertisements

Benefits

Checkout-Links

Checkouts

Custom-Fields

Customer Portal

Files

Metrics

Oauth2

Orders

Subscriptions

checkouts

Create Checkout Session

post
/v1/checkouts/custom/
Create a checkout session.
Methods
OpenID Connect
Personal Access Token
Subjects
Organization
User
Scopes
checkouts:write

Request Body

Checkout session created.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Key-value object storing custom field values.
Payment processor used.
Status of the checkout session.
Client secret used to update and complete the checkout session from the client.
URL where the customer can access the checkout session.
Expiration date and time of the checkout session.
URL where the customer will be redirected after a successful payment.
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.
Computed tax amount to pay in cents.
Currency code of the checkout session.
Subtotal amount in cents, including discounts and before tax.
Total amount to pay in cents, including discounts and after tax.
ID of the product to checkout.
ID of the product price to checkout.
ID of the discount applied to the checkout.
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.
Whether the discount is applicable to the checkout. Typically, free and custom prices are not discountable.
Whether the product price is free, regardless of discounts.
Whether the checkout requires payment, e.g. in case of free products or discounts that cover the total amount.
Whether the checkout requires setting up a payment method, regardless of the amount, e.g. subscriptions that have first free cycles.
Whether the checkout requires a payment form, whether because of a payment or payment method setup.
Product data for a checkout session.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the product.
The name of the product.
The description of the product.
Whether the product is a subscription tier.
Whether the product is archived and no longer available.
The ID of the organization owning the product.
List of prices for this product.
List of benefits granted by the product.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the benefit.
The type of the benefit.
The description of the benefit.
Whether the benefit is selectable when creating a product.
Whether the benefit is deletable.
The ID of the organization owning the benefit.
List of medias associated to the product.
The ID of the object.
ID of the custom field.
Order of the custom field in the resource.
Whether the value is required for this custom field.
curl -X POST \
    'https://api.polar.sh/v1/checkouts/custom/' \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer <token>" \
    -d '{
  "payment_processor": "stripe",
  "product_id": "00000000-0000-0000-0000-000000000000"
}'
Responses
{
  "created_at": "2024-12-21T00:00:00.000Z",
  "modified_at": "2024-12-21T00:00:00.000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "custom_field_data": {},
  "payment_processor": "stripe",
  "status": "open",
  "client_secret": "string",
  "url": "string",
  "expires_at": "2024-12-21T00: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": "2024-12-21T00:00:00.000Z",
    "modified_at": "2024-12-21T00: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": "2024-12-21T00:00:00.000Z",
        "modified_at": "2024-12-21T00: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": "2024-12-21T00:00:00.000Z",
        "modified_at": "2024-12-21T00: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": "2024-12-21T00:00:00.000Z",
        "version": "string",
        "service": "product_media",
        "is_uploaded": false,
        "created_at": "2024-12-21T00:00:00.000Z",
        "size_readable": "string",
        "public_url": "string"
      }
    ]
  },
  "product_price": {
    "created_at": "2024-12-21T00:00:00.000Z",
    "modified_at": "2024-12-21T00: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": "2024-12-21T00:00:00.000Z",
        "modified_at": "2024-12-21T00: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": {}
}