struct

Polar::Models::CheckoutPublicConfirmed

Inherits JSON::Serializable < Struct < Value < Object

Model representing a CheckoutPublicConfirmed

This struct is auto-generated from the Polar.sh OpenAPI specification. It uses JSON::Serializable for automatic JSON parsing and serialization.

Constructors

new(pull : JSON::PullParser)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

Instance methods

active_trial_interval

Interval unit of the trial period, if any. This value is either set from the checkout, if trial_interval is set, or from the selected product.

Source

active_trial_interval_count

Number of interval units of the trial period, if any. This value is either set from the checkout, if trial_interval_count is set, or from the selected product.

Source

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.

Source

amount

Amount in cents, before discounts and taxes.

Source

attached_custom_fields

Source

billing_address_fields

Determine which billing address fields should be disabled, optional or required in the checkout form.

Source

client_secret

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

Source

created_at

Creation timestamp of the object.

Source

currency

Currency code of the checkout session.

Source

custom_field_data

Key-value object storing custom field values.

Source

customer_billing_address

Source

customer_billing_name

Source

customer_email

Email address of the customer.

Source

customer_id

Source

customer_ip_address

Source

customer_name

Name of the customer.

Source

customer_session_token

Source

customer_tax_id

Source

discount

Source

discount_amount

Discount amount in cents.

Source

discount_id

ID of the discount applied to the checkout.

Source

embed_origin

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.

Source

expires_at

Expiration date and time of the checkout session.

Source

The ID of the object.

Source

is_business_customer

Whether the customer is a business or an individual. If true, the customer will be required to fill their full billing address and billing name.

Source

is_discount_applicable

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

Source

is_free_product_price

Whether the product price is free, regardless of discounts.

Source

is_payment_form_required

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

Source

is_payment_required

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

Source

is_payment_setup_required

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

Source

modified_at

Last modification timestamp of the object.

Source

net_amount

Amount in cents, after discounts but before taxes.

Source

organization

Source

organization_id

ID of the organization owning the checkout session.

Source

payment_processor

Payment processor used.

Source

payment_processor_metadata

Source

price_per_seat

Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing.

Source

product

Product selected to checkout.

Source

product_id

ID of the product to checkout.

Source

product_price

Price of the selected product.

Source

product_price_id

ID of the product price to checkout.

Source

products

List of products available to select.

Source

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.

Source

return_url

When set, a back button will be shown in the checkout to return to this URL.

Source

seats

Number of seats for seat-based pricing.

Source

status

Source

success_url

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

Source