checkout.updated

Sent when a checkout is updated.

Discord & Slack support: Basic

type

string

required

Allowed value: "checkout.updated"

Example:

"checkout.updated"

data

object

required

Checkout session data retrieved using an access token.

data.created_at

string

required

Creation timestamp of the object.

data.modified_at

string | null

required

Last modification timestamp of the object.

data.id

string

required

The ID of the object.

data.payment_processor

enum<string>

required

Payment processor used.

Available options:

stripe

data.status

enum<string>

required

Status of the checkout session.

Available options:

open,

expired,

confirmed,

succeeded,

failed

data.client_secret

string

required

Client secret used to update and complete the checkout session from the client.

data.url

string

required

URL where the customer can access the checkout session.

data.expires_at

string

required

Expiration date and time of the checkout session.

data.success_url

string

required

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

data.embed_origin

string | null

required

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.

data.amount

integer | null

required

Amount to pay in cents. Only useful for custom prices, it'll be ignored for fixed and free prices.

Required range: 50 <= x <= 99999999

data.tax_amount

integer | null

required

Computed tax amount to pay in cents.

data.currency

string | null

required

Currency code of the checkout session.

data.subtotal_amount

integer | null

required

Subtotal amount in cents, including discounts and before tax.

data.total_amount

integer | null

required

Total amount to pay in cents, including discounts and after tax.

data.product_id

string

required

ID of the product to checkout.

data.product_price_id

string

required

ID of the product price to checkout.

data.discount_id

string | null

required

ID of the discount applied to the checkout.

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

data.is_discount_applicable

boolean

required

Whether the discount is applicable to the checkout. Typically, free and custom prices are not discountable.

data.is_free_product_price

boolean

required

Whether the product price is free, regardless of discounts.

data.is_payment_required

boolean

required

Whether the checkout requires payment, e.g. in case of free products or discounts that cover the total amount.

data.is_payment_setup_required

boolean

required

Whether the checkout requires setting up a payment method, regardless of the amount, e.g. subscriptions that have first free cycles.

data.is_payment_form_required

boolean

required

Whether the checkout requires a payment form, whether because of a payment or payment method setup.

data.customer_id

string | null

required

data.customer_name

string | null

required

Name of the customer.

data.customer_email

string | null

required

Email address of the customer.

data.customer_ip_address

string | null

required

data.customer_billing_address

object | null

required

Billing address of the customer.

data.customer_tax_id

string | null

required

data.payment_processor_metadata

object

required

data.metadata

object

required

data.customer_external_id

string | null

required

ID of the customer in your system. If a matching customer exists on Polar, the resulting order will be linked to this customer. Otherwise, a new customer will be created with this external ID set.

data.products

object[]

required

List of products available to select.

Product data for a checkout session.

data.products.created_at

string

required

Creation timestamp of the object.

data.products.modified_at

string | null

required

Last modification timestamp of the object.

data.products.id

string

required

The ID of the product.

data.products.name

string

required

The name of the product.

data.products.description

string | null

required

The description of the product.

data.products.recurring_interval

enum<string> | null

required

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

Available options:

month,

year

data.products.is_recurring

boolean

required

Whether the product is a subscription.

data.products.is_archived

boolean

required

Whether the product is archived and no longer available.

data.products.organization_id

string

required

The ID of the organization owning the product.

data.products.prices

object[]

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.

data.products.benefits

object[]

required

List of benefits granted by the product.

data.products.medias

object[]

required

List of medias associated to the product.

File to be used as a product media file.

data.product

object

required

Product selected to checkout.

data.product.created_at

string

required

Creation timestamp of the object.

data.product.modified_at

string | null

required

Last modification timestamp of the object.

data.product.id

string

required

The ID of the product.

data.product.name

string

required

The name of the product.

data.product.description

string | null

required

The description of the product.

data.product.recurring_interval

enum<string> | null

required

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

Available options:

month,

year

data.product.is_recurring

boolean

required

Whether the product is a subscription.

data.product.is_archived

boolean

required

Whether the product is archived and no longer available.

data.product.organization_id

string

required

The ID of the organization owning the product.

data.product.prices

object[]

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.

data.product.benefits

object[]

required

List of benefits granted by the product.

data.product.medias

object[]

required

List of medias associated to the product.

File to be used as a product media file.

data.product_price

object

required

Price of the selected product.

data.discount

object | null

required

Schema for a fixed amount discount that is applied once or forever.

data.subscription_id

string | null

required

data.attached_custom_fields

object[]

required

Schema of a custom field attached to a resource.

data.attached_custom_fields.custom_field_id

string

required

ID of the custom field.

data.attached_custom_fields.custom_field

object

required

Schema for a custom field of type text.

data.attached_custom_fields.order

integer

required

Order of the custom field in the resource.

data.attached_custom_fields.required

boolean

required

Whether the value is required for this custom field.

data.customer_metadata

object

required

data.custom_field_data

object

Key-value object storing custom field values.

Was this page helpful?

checkout.created

subscription.created

{
  "type": "checkout.updated",
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "custom_field_data": {},
    "payment_processor": "stripe",
    "status": "open",
    "client_secret": "<string>",
    "url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "success_url": "<string>",
    "embed_origin": "<string>",
    "amount": 50000024,
    "tax_amount": 123,
    "currency": "<string>",
    "subtotal_amount": 123,
    "total_amount": 123,
    "product_id": "<string>",
    "product_price_id": "<string>",
    "discount_id": "<string>",
    "allow_discount_codes": 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>",
    "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": "US"
    },
    "customer_tax_id": "<string>",
    "payment_processor_metadata": {},
    "metadata": {},
    "customer_external_id": "<string>",
    "products": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "recurring_interval": "month",
        "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>",
            "is_archived": true,
            "product_id": "<string>",
            "type": "<string>",
            "recurring_interval": "month",
            "price_currency": "<string>",
            "price_amount": 123,
            "legacy": true
          }
        ],
        "benefits": [
          {
            "created_at": "2023-11-07T05:31:56Z",
            "modified_at": "2023-11-07T05:31:56Z",
            "id": "<string>",
            "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>"
          }
        ]
      }
    ],
    "product": {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "recurring_interval": "month",
      "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>",
          "is_archived": true,
          "product_id": "<string>",
          "type": "<string>",
          "recurring_interval": "month",
          "price_currency": "<string>",
          "price_amount": 123,
          "legacy": true
        }
      ],
      "benefits": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "modified_at": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "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>"
        }
      ]
    },
    "product_price": {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "amount_type": "<string>",
      "is_archived": true,
      "product_id": "<string>",
      "type": "<string>",
      "recurring_interval": "month",
      "price_currency": "<string>",
      "price_amount": 123,
      "legacy": true
    },
    "discount": {
      "duration": "once",
      "type": "fixed",
      "amount": 123,
      "currency": "<string>",
      "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": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
          "properties": {
            "form_label": "<string>",
            "form_help_text": "<string>",
            "form_placeholder": "<string>",
            "textarea": true,
            "min_length": 1,
            "max_length": 1
          }
        },
        "order": 123,
        "required": true
      }
    ],
    "customer_metadata": {}
  }
}

Core API

Customer Portal API

Webhook Events

OAuth 2.0 API

checkout.updated