Search documentation of polar_express

# PolarExpress.Schemas.CheckoutUpdate (polar_express v0.1.5)

Copy Markdown View Source

CheckoutUpdate

Update an existing checkout session using an access token.

## Summary

### Types

t()

### Functions

schema_name()

## Types

# t()

    @type t() :: %PolarExpress.Schemas.CheckoutUpdate{
      allow_discount_codes: boolean() | nil,
      allow_trial: boolean() | nil,
      amount: integer() | nil,
      currency: PolarExpress.Schemas.PresentmentCurrency.t() | nil,
      custom_field_data:
        %{
          required(String.t()) =>
            String.t() | integer() | boolean() | DateTime.t() | nil
        }
        | nil,
      customer_billing_address: PolarExpress.Schemas.AddressInput.t() | nil,
      customer_billing_name: String.t() | nil,
      customer_email: String.t() | nil,
      customer_ip_address: String.t() | nil,
      customer_metadata:
        %{
          required(String.t()) => String.t() | integer() | float() | boolean() | nil
        }
        | nil,
      customer_name: String.t() | nil,
      customer_tax_id: String.t() | nil,
      discount_id: String.t() | nil,
      embed_origin: String.t() | nil,
      is_business_customer: boolean() | nil,
      locale: String.t() | nil,
      metadata:
        %{
          required(String.t()) => String.t() | integer() | float() | boolean() | nil
        }
        | nil,
      product_id: String.t() | nil,
      product_price_id: String.t() | nil,
      require_billing_address: boolean() | nil,
      return_url: String.t() | nil,
      seats: integer() | nil,
      success_url: String.t() | nil,
      trial_interval: PolarExpress.Schemas.TrialInterval.t() | nil,
      trial_interval_count: integer() | nil
    }

- `allow_discount_codes` - 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. Nullable.
- `allow_trial` - Whether to enable the trial period for the checkout session. If `false`, the trial period will be disabled, even if the selected product has a trial configured. Nullable.
- `amount` - Nullable.
- `currency` - Nullable.
- `custom_field_data` - Key-value object storing custom field values.
- `customer_billing_address` - Nullable.
- `customer_billing_name` - Nullable.
- `customer_email` - Nullable.
- `customer_ip_address` - Nullable.
- `customer_metadata` - Key-value object allowing you to store additional information that'll be copied to the created customer.

The key must be a string with a maximum length of 40 characters. The value must be either:

- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean

You can store up to 50 key-value pairs. Nullable.

- `customer_name` - Nullable.
- `customer_tax_id` - Nullable.
- `discount_id` - ID of the discount to apply to the checkout. Nullable.
- `embed_origin` - If you plan to embed the checkout session, set this to the Origin of the embedding page. It'll allow the Polar iframe to communicate with the parent page. Nullable.
- `is_business_customer` - Nullable.
- `locale` - Nullable.
- `metadata` - Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean

You can store up to 50 key-value pairs.

- `product_id` - ID of the product to checkout. Must be present in the checkout's product list. Nullable.
- `product_price_id` - ID of the product price to checkout. Must correspond to a price present in the checkout's product list. Nullable. Deprecated.
- `require_billing_address` - 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. If you preset the billing address, this setting will be automatically set to `true`. Nullable.
- `return_url` - When set, a back button will be shown in the checkout to return to this URL. Nullable.
- `seats` - Number of seats for seat-based pricing. Nullable.
- `success_url` - URL where the customer will be redirected after a successful payment.You can add the `checkout_id={CHECKOUT_ID}` query parameter to retrieve the checkout session id. Nullable.
- `trial_interval` - The interval unit for the trial period. Nullable.
- `trial_interval_count` - The number of interval units for the trial period. Nullable.

## Functions

# schema_name()