@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

@return Crest::Request

Returns a list of Checkout Sessions.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return Checkout Sessions that were created during the given date interval. @optional @param payment_intent [String?] Only return the Checkout Session for the PaymentIntent specified. @optional @param subscription [String?] Only return the Checkout Session for the subscription specified. @optional @param customer_details [Stripe::CustomerDetailsParams?] Only return the Checkout Sessions for the Customer details specified. @optional @param customer [String?] Only return the Checkout Sessions for the Customer specified. @optional @param payment_link [String?] Only return the Checkout Sessions for the Payment Link specified. @optional @param status [String?] Only return the Checkout Sessions matching the given status. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentPagesCheckoutSessionList]

<p>Returns a list of Checkout Sessions.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return Checkout Sessions that were created during the given date interval. @optional @param payment_intent [String?] Only return the Checkout Session for the PaymentIntent specified. @optional @param subscription [String?] Only return the Checkout Session for the subscription specified. @optional @param customer_details [Stripe::CustomerDetailsParams?] Only return the Checkout Sessions for the Customer details specified. @optional @param customer [String?] Only return the Checkout Sessions for the Customer specified. @optional @param payment_link [String?] Only return the Checkout Sessions for the Payment Link specified. @optional @param status [String?] Only return the Checkout Sessions matching the given status. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

Retrieves a Session object.

@required @param session [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::CheckoutSession]

<p>Retrieves a Session object.</p> @required @param session [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

@required @param session [String?] @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::PaymentPagesCheckoutSessionListLineItems]

<p>When retrieving a Checkout Session, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p> @required @param session [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

<p>When retrieving a Checkout Session, there is an includable <strong>line_items</strong> property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.</p> @required @param session [String?] @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentPagesCheckoutSessionListLineItems, Integer, Hash)] Stripe::PaymentPagesCheckoutSessionListLineItems, response status code and response headers

<p>Retrieves a Session object.</p> @required @param session [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::CheckoutSession, Integer, Hash)] Stripe::CheckoutSession, response status code and response headers

<p>Returns a list of Checkout Sessions.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return Checkout Sessions that were created during the given date interval. @optional @param payment_intent [String?] Only return the Checkout Session for the PaymentIntent specified. @optional @param subscription [String?] Only return the Checkout Session for the subscription specified. @optional @param customer_details [Stripe::CustomerDetailsParams?] Only return the Checkout Sessions for the Customer details specified. @optional @param customer [String?] Only return the Checkout Sessions for the Customer specified. @optional @param payment_link [String?] Only return the Checkout Sessions for the Payment Link specified. @optional @param status [String?] Only return the Checkout Sessions matching the given status. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::PaymentPagesCheckoutSessionList, Integer, Hash)] Stripe::PaymentPagesCheckoutSessionList, response status code and response headers

Creates a Session object.

@optional @param after_expiration [Stripe::AfterExpirationParams?] @optional @param allow_promotion_codes [Bool?] Enables user redeemable promotion codes. @optional @param automatic_tax [Stripe::AutomaticTaxParams?] @optional @param billing_address_collection [String?] Specify whether Checkout should collect the customer's billing address. Defaults to `auto`. @optional @param cancel_url [String?] If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded`. @optional @param client_reference_id [String?] 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. @optional @param consent_collection [Stripe::ConsentCollectionParams?] @optional @param currency [String?] Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. @optional @param custom_fields [Array(Stripe::CustomFieldParam)?] Collect additional information from your customer using custom fields. Up to 3 fields are supported. @optional @param custom_text [Stripe::CustomTextParam?] @optional @param customer [String?] ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved 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](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) will be used if it’s a card, otherwise the most recently saved 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](https://stripe.com/docs/api/customers/object#customer_object-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 `subscription` mode or with `customer_creation` set as `always` in `payment` 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`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. @optional @param customer_creation [String?] Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) 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](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details). Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/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. @optional @param customer_email [String?] 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. @optional @param customer_update [Stripe::CustomerUpdateParams?] @optional @param discounts [Array(Stripe::DiscountParams)?] The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. @optional @param invoice_creation [Stripe::InvoiceCreationParams?] @optional @param line_items [Array(Stripe::LineItemParams)?] A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/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 will be on the initial invoice only. @optional @param locale [String?] The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. @optional @param metadata [Hash(String, String)?] @optional @param mode [String?] The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item. @optional @param payment_intent_data [Stripe::PaymentIntentDataParams?] @optional @param payment_method_collection [String?] Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0. This may occur if the Checkout Session includes a free trial or a discount. Can only be set in `subscription` mode. Defaults to `always`. If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). @optional @param payment_method_configuration [String?] The ID of the payment method configuration to use with this Checkout session. @optional @param payment_method_data [Stripe::PaymentMethodDataParam?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details. Read more about the supported payment methods and their requirements in our [payment method details guide](/docs/payments/checkout/payment-methods). 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. @optional @param phone_number_collection [Stripe::PhoneNumberCollectionParams?] @optional @param redirect_on_completion [String?] This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. @optional @param return_url [String?] The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter is required if ui_mode is `embedded` and redirect-based payment methods are enabled on the session. @optional @param saved_payment_method_options [Stripe::SavedPaymentMethodOptionsParam?] @optional @param setup_intent_data [Stripe::SetupIntentDataParam?] @optional @param shipping_address_collection [Stripe::ShippingAddressCollectionParams?] @optional @param shipping_options [Array(Stripe::ShippingOptionParams)?] The shipping rate options to apply to this Session. Up to a maximum of 5. @optional @param submit_type [String?] 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. If blank or `auto`, `pay` is used. @optional @param subscription_data [Stripe::SubscriptionDataParams?] @optional @param success_url [String?] The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is `embedded`. If you’d like to use information from the successful Checkout Session on your page, read the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). @optional @param tax_id_collection [Stripe::TaxIdCollectionParams?] @optional @param ui_mode [String?] The UI mode of the Session. Defaults to `hosted`. @return [Stripe::CheckoutSession]

<p>Creates a Session object.</p> @optional @param after_expiration [Stripe::AfterExpirationParams?] @optional @param allow_promotion_codes [Bool?] Enables user redeemable promotion codes. @optional @param automatic_tax [Stripe::AutomaticTaxParams?] @optional @param billing_address_collection [String?] Specify whether Checkout should collect the customer's billing address. Defaults to auto. @optional @param cancel_url [String?] If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is embedded. @optional @param client_reference_id [String?] 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. @optional @param consent_collection [Stripe::ConsentCollectionParams?] @optional @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. Required in setup mode when payment_method_types is not set. @optional @param custom_fields [Array(Stripe::CustomFieldParam)?] Collect additional information from your customer using custom fields. Up to 3 fields are supported. @optional @param custom_text [Stripe::CustomTextParam?] @optional @param customer [String?] ID of an existing Customer, if one exists. In payment mode, the customer’s most recently saved 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, otherwise the most recently saved 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 subscription mode or with customer_creation set as always in payment 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. @optional @param customer_creation [String?] 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 are grouped by 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. @optional @param customer_email [String?] 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. @optional @param customer_update [Stripe::CustomerUpdateParams?] @optional @param discounts [Array(Stripe::DiscountParams)?] The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. @optional @param invoice_creation [Stripe::InvoiceCreationParams?] @optional @param line_items [Array(Stripe::LineItemParams)?] 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 will be on the initial invoice only. @optional @param locale [String?] The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used. @optional @param metadata [Hash(String, String)?] @optional @param mode [String?] The mode of the Checkout Session. Pass subscription if the Checkout Session includes at least one recurring item. @optional @param payment_intent_data [Stripe::PaymentIntentDataParams?] @optional @param payment_method_collection [String?] Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0. This may occur if the Checkout Session includes a free trial or a discount. Can only be set in subscription mode. Defaults to always. If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial. @optional @param payment_method_configuration [String?] The ID of the payment method configuration to use with this Checkout session. @optional @param payment_method_data [Stripe::PaymentMethodDataParam?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] A list of the types of payment methods (e.g., card) this Checkout Session can accept. You can omit this attribute to manage your payment methods from the Stripe Dashboard. See Dynamic Payment Methods for more details. 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. @optional @param phone_number_collection [Stripe::PhoneNumberCollectionParams?] @optional @param redirect_on_completion [String?] This parameter applies to ui_mode: embedded. Learn more about the redirect behavior of embedded sessions. Defaults to always. @optional @param return_url [String?] The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter is required if ui_mode is embedded and redirect-based payment methods are enabled on the session. @optional @param saved_payment_method_options [Stripe::SavedPaymentMethodOptionsParam?] @optional @param setup_intent_data [Stripe::SetupIntentDataParam?] @optional @param shipping_address_collection [Stripe::ShippingAddressCollectionParams?] @optional @param shipping_options [Array(Stripe::ShippingOptionParams)?] The shipping rate options to apply to this Session. Up to a maximum of 5. @optional @param submit_type [String?] 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. If blank or auto, pay is used. @optional @param subscription_data [Stripe::SubscriptionDataParams?] @optional @param success_url [String?] The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is embedded. If you’d like to use information from the successful Checkout Session on your page, read the guide on customizing your success page. @optional @param tax_id_collection [Stripe::TaxIdCollectionParams?] @optional @param ui_mode [String?] The UI mode of the Session. Defaults to hosted. @return nil

Updates a Session object.

@required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Stripe::CheckoutSession]

<p>Updates a Session object.</p> @required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil

A Session can be expired when it is in one of these statuses: open

After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.

@required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::CheckoutSession]

<p>A Session can be expired when it is in one of these statuses: <code>open</code> </p> <p>After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.</p> @required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil

<p>A Session can be expired when it is in one of these statuses: <code>open</code> </p> <p>After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.</p> @required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::CheckoutSession, Integer, Hash)] Stripe::CheckoutSession, response status code and response headers

<p>Updates a Session object.</p> @required @param session [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::CheckoutSession, Integer, Hash)] Stripe::CheckoutSession, response status code and response headers

<p>Creates a Session object.</p> @optional @param after_expiration [Stripe::AfterExpirationParams?] @optional @param allow_promotion_codes [Bool?] Enables user redeemable promotion codes. @optional @param automatic_tax [Stripe::AutomaticTaxParams?] @optional @param billing_address_collection [String?] Specify whether Checkout should collect the customer's billing address. Defaults to auto. @optional @param cancel_url [String?] If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is embedded. @optional @param client_reference_id [String?] 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. @optional @param consent_collection [Stripe::ConsentCollectionParams?] @optional @param currency [String?] Three-letter ISO currency code, in lowercase. Must be a supported currency. Required in setup mode when payment_method_types is not set. @optional @param custom_fields [Array(Stripe::CustomFieldParam)?] Collect additional information from your customer using custom fields. Up to 3 fields are supported. @optional @param custom_text [Stripe::CustomTextParam?] @optional @param customer [String?] ID of an existing Customer, if one exists. In payment mode, the customer’s most recently saved 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, otherwise the most recently saved 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 subscription mode or with customer_creation set as always in payment 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. @optional @param customer_creation [String?] 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 are grouped by 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. @optional @param customer_email [String?] 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. @optional @param customer_update [Stripe::CustomerUpdateParams?] @optional @param discounts [Array(Stripe::DiscountParams)?] The coupon or promotion code to apply to this Session. Currently, only up to one may be specified. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation. @optional @param invoice_creation [Stripe::InvoiceCreationParams?] @optional @param line_items [Array(Stripe::LineItemParams)?] 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 will be on the initial invoice only. @optional @param locale [String?] The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser's locale is used. @optional @param metadata [Hash(String, String)?] @optional @param mode [String?] The mode of the Checkout Session. Pass subscription if the Checkout Session includes at least one recurring item. @optional @param payment_intent_data [Stripe::PaymentIntentDataParams?] @optional @param payment_method_collection [String?] Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0. This may occur if the Checkout Session includes a free trial or a discount. Can only be set in subscription mode. Defaults to always. If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial. @optional @param payment_method_configuration [String?] The ID of the payment method configuration to use with this Checkout session. @optional @param payment_method_data [Stripe::PaymentMethodDataParam?] @optional @param payment_method_options [Stripe::PaymentMethodOptionsParam?] @optional @param payment_method_types [Array(String)?] A list of the types of payment methods (e.g., card) this Checkout Session can accept. You can omit this attribute to manage your payment methods from the Stripe Dashboard. See Dynamic Payment Methods for more details. 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. @optional @param phone_number_collection [Stripe::PhoneNumberCollectionParams?] @optional @param redirect_on_completion [String?] This parameter applies to ui_mode: embedded. Learn more about the redirect behavior of embedded sessions. Defaults to always. @optional @param return_url [String?] The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter is required if ui_mode is embedded and redirect-based payment methods are enabled on the session. @optional @param saved_payment_method_options [Stripe::SavedPaymentMethodOptionsParam?] @optional @param setup_intent_data [Stripe::SetupIntentDataParam?] @optional @param shipping_address_collection [Stripe::ShippingAddressCollectionParams?] @optional @param shipping_options [Array(Stripe::ShippingOptionParams)?] The shipping rate options to apply to this Session. Up to a maximum of 5. @optional @param submit_type [String?] 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. If blank or auto, pay is used. @optional @param subscription_data [Stripe::SubscriptionDataParams?] @optional @param success_url [String?] The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is embedded. If you’d like to use information from the successful Checkout Session on your page, read the guide on customizing your success page. @optional @param tax_id_collection [Stripe::TaxIdCollectionParams?] @optional @param ui_mode [String?] The UI mode of the Session. Defaults to hosted. @return [Tuple(Stripe::CheckoutSession, Integer, Hash)] Stripe::CheckoutSession, response status code and response headers