postCheckoutSessionsRequestBodyAfterExpiration :: Maybe PostCheckoutSessionsRequestBodyAfterExpiration'after_expiration: Configure actions after a Checkout Session has expired.
postCheckoutSessionsRequestBodyAutomaticTax :: Maybe PostCheckoutSessionsRequestBodyAutomaticTax'automatic_tax: Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
postCheckoutSessionsRequestBodyBillingAddressCollection :: Maybe PostCheckoutSessionsRequestBodyBillingAddressCollection'billing_address_collection: Specify whether Checkout should collect the customer's billing address.
postCheckoutSessionsRequestBodyCancelUrl :: Textcancel_url: The URL the customer will be directed to if they decide to cancel payment and return to your website.
Constraints:
postCheckoutSessionsRequestBodyClientReferenceId :: Maybe Textclient_reference_id: A unique string to reference the Checkout Session. This can be a
customer ID, a cart ID, or similar, and can be used to reconcile the
session with your internal systems.
Constraints:
postCheckoutSessionsRequestBodyConsentCollection :: Maybe PostCheckoutSessionsRequestBodyConsentCollection'consent_collection: Configure fields for the Checkout Session to gather active consent from customers.
postCheckoutSessionsRequestBodyCustomer :: Maybe Textcustomer: ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card
payment method will be used to prefill the email, name, card details, and billing address
on the Checkout page. In `subscription` mode, the customer’s default payment method
will be used if it’s a card, and otherwise the most recent card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.
If the Customer already has a valid email set, the email will be prefilled and not editable in Checkout.
If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
If blank for Checkout Sessions in `payment` or `subscription` mode, Checkout will create a new Customer object based on information provided during the payment flow.
You can set `payment_intent_data.setup_future_usage` to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
Constraints:
postCheckoutSessionsRequestBodyCustomerCreation :: Maybe PostCheckoutSessionsRequestBodyCustomerCreation'customer_creation: Configure whether a Checkout Session creates a Customer during Session confirmation.
When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
with customer_details.
Sessions that don't create Customers instead create Guest Customers
in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
Can only be set in `payment` and `setup` mode.
postCheckoutSessionsRequestBodyCustomerEmail :: Maybe Textcustomer_email: If provided, this value will be used when the Customer object is created.
If not provided, customers will be asked to enter their email address.
Use this parameter to prefill customer data if you already have an email
on file. To access information about the customer once a session is
complete, use the `customer` field.
postCheckoutSessionsRequestBodyCustomerUpdate :: Maybe PostCheckoutSessionsRequestBodyCustomerUpdate'customer_update: Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
postCheckoutSessionsRequestBodyDiscounts :: Maybe [PostCheckoutSessionsRequestBodyDiscounts']discounts: The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
postCheckoutSessionsRequestBodyExpand :: Maybe [Text]expand: Specifies which fields in the response should be expanded.
postCheckoutSessionsRequestBodyExpiresAt :: Maybe Intexpires_at: The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 1 to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
postCheckoutSessionsRequestBodyLineItems :: Maybe [PostCheckoutSessionsRequestBodyLineItems']line_items: A list of items the customer is purchasing. Use this parameter to pass one-time or recurring Prices.
For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.
For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices in will be on the initial invoice only.
postCheckoutSessionsRequestBodyLocale :: Maybe PostCheckoutSessionsRequestBodyLocale'locale: The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
postCheckoutSessionsRequestBodyMode :: Maybe PostCheckoutSessionsRequestBodyMode'mode: The mode of the Checkout Session. Required when using prices or `setup` mode. Pass `subscription` if the Checkout Session includes at least one recurring item.
postCheckoutSessionsRequestBodyPaymentIntentData :: Maybe PostCheckoutSessionsRequestBodyPaymentIntentData'payment_intent_data: A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
postCheckoutSessionsRequestBodyPaymentMethodTypes :: Maybe [PostCheckoutSessionsRequestBodyPaymentMethodTypes']payment_method_types: A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
Do not include this attribute if you prefer to manage your payment methods from the Stripe Dashboard.
Read more about the supported payment methods and their requirements in our payment
method details guide.
If multiple payment methods are passed, Checkout will dynamically reorder them to
prioritize the most relevant payment methods based on the customer's location and
other characteristics.
postCheckoutSessionsRequestBodyPhoneNumberCollection :: Maybe PostCheckoutSessionsRequestBodyPhoneNumberCollection'phone_number_collection: Controls phone number collection settings for the session.
We recommend that you review your privacy policy and check with your legal contacts
before using this feature. Learn more about collecting phone numbers with Checkout.
postCheckoutSessionsRequestBodySetupIntentData :: Maybe PostCheckoutSessionsRequestBodySetupIntentData'setup_intent_data: A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
postCheckoutSessionsRequestBodyShippingAddressCollection :: Maybe PostCheckoutSessionsRequestBodyShippingAddressCollection'shipping_address_collection: When set, provides configuration for Checkout to collect a shipping address from a customer.
postCheckoutSessionsRequestBodyShippingOptions :: Maybe [PostCheckoutSessionsRequestBodyShippingOptions']shipping_options: The shipping rate options to apply to this Session.
postCheckoutSessionsRequestBodySubmitType :: Maybe PostCheckoutSessionsRequestBodySubmitType'submit_type: Describes the type of transaction being performed by Checkout in order to customize
relevant text on the page, such as the submit button. `submit_type` can only be
specified on Checkout Sessions in `payment` mode, but not Checkout Sessions
in `subscription` or `setup` mode.
postCheckoutSessionsRequestBodySubscriptionData :: Maybe PostCheckoutSessionsRequestBodySubscriptionData'subscription_data: A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
postCheckoutSessionsRequestBodySuccessUrl :: Textsuccess_url: The URL to which Stripe should send customers when payment or setup
is complete.
If you’d like to use information from the successful Checkout Session on your page,
read the guide on customizing your success page.
Constraints:
postCheckoutSessionsRequestBodyTaxIdCollection :: Maybe PostCheckoutSessionsRequestBodyTaxIdCollection'tax_id_collection: Controls tax ID collection settings for the session.