Polar::Models::CheckoutProductsCreate
Inherits JSON::Serializable < Struct < Value < Object
Model representing a CheckoutProductsCreate
This struct is auto-generated from the Polar.sh OpenAPI specification.
It uses JSON::Serializable for automatic JSON parsing and serialization.
Constructors
Instance methods
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.
ID of an existing customer in the organization. The customer data will be pre-filled in the checkout form. The resulting order will be linked to this customer.
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.
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.
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.
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.
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.
List of product IDs available to select at that checkout. The first one will be selected by default.
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.
ID of a subscription to upgrade. It must be on a free pricing. If checkout is successful, metadata set on this checkout will be copied to the subscription, and existing keys will be overwritten.
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.