Class: Stripe::Checkout::Session::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/checkout/session.rb

Defined Under Namespace

Classes: AdaptivePricing, AfterExpiration, AutomaticTax, CheckoutItem, ConsentCollection, CustomField, CustomText, CustomerUpdate, Discount, InvoiceCreation, LineItem, OptionalItem, PaymentIntentData, PaymentMethodData, PaymentMethodOptions, Permissions, PhoneNumberCollection, SavedPaymentMethodOptions, SetupIntentData, ShippingAddressCollection, ShippingOption, SubscriptionData, TaxIdCollection, WalletOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(adaptive_pricing: nil, after_expiration: nil, allow_promotion_codes: nil, automatic_tax: nil, billing_address_collection: nil, cancel_url: nil, client_reference_id: nil, consent_collection: nil, currency: nil, custom_fields: nil, custom_text: nil, customer: nil, customer_account: nil, customer_creation: nil, customer_email: nil, customer_update: nil, discounts: nil, expand: nil, expires_at: nil, invoice_creation: nil, line_items: nil, locale: nil, metadata: nil, mode: nil, optional_items: nil, origin_context: nil, payment_intent_data: nil, payment_method_collection: nil, payment_method_configuration: nil, payment_method_data: nil, payment_method_options: nil, payment_method_types: nil, permissions: nil, phone_number_collection: nil, redirect_on_completion: nil, return_url: nil, saved_payment_method_options: nil, setup_intent_data: nil, shipping_address_collection: nil, shipping_options: nil, submit_type: nil, subscription_data: nil, success_url: nil, tax_id_collection: nil, ui_mode: nil, wallet_options: nil, checkout_items: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
 
# File 'lib/stripe/resources/checkout/session.rb', line 4578

def initialize(
  adaptive_pricing: nil,
  after_expiration: nil,
  allow_promotion_codes: nil,
  automatic_tax: nil,
  billing_address_collection: nil,
  cancel_url: nil,
  client_reference_id: nil,
  consent_collection: nil,
  currency: nil,
  custom_fields: nil,
  custom_text: nil,
  customer: nil,
  customer_account: nil,
  customer_creation: nil,
  customer_email: nil,
  customer_update: nil,
  discounts: nil,
  expand: nil,
  expires_at: nil,
  invoice_creation: nil,
  line_items: nil,
  locale: nil,
  metadata: nil,
  mode: nil,
  optional_items: nil,
  origin_context: nil,
  payment_intent_data: nil,
  payment_method_collection: nil,
  payment_method_configuration: nil,
  payment_method_data: nil,
  payment_method_options: nil,
  payment_method_types: nil,
  permissions: nil,
  phone_number_collection: nil,
  redirect_on_completion: nil,
  return_url: nil,
  saved_payment_method_options: nil,
  setup_intent_data: nil,
  shipping_address_collection: nil,
  shipping_options: nil,
  submit_type: nil,
  subscription_data: nil,
  success_url: nil,
  tax_id_collection: nil,
  ui_mode: nil,
  wallet_options: nil,
  checkout_items: nil
)
  @adaptive_pricing = adaptive_pricing
  @after_expiration = after_expiration
  @allow_promotion_codes = allow_promotion_codes
  @automatic_tax = automatic_tax
  @billing_address_collection = billing_address_collection
  @cancel_url = cancel_url
  @client_reference_id = client_reference_id
  @consent_collection = consent_collection
  @currency = currency
  @custom_fields = custom_fields
  @custom_text = custom_text
  @customer = customer
  @customer_account = 
  @customer_creation = customer_creation
  @customer_email = customer_email
  @customer_update = customer_update
  @discounts = discounts
  @expand = expand
  @expires_at = expires_at
  @invoice_creation = invoice_creation
  @line_items = line_items
  @locale = locale
  @metadata = metadata
  @mode = mode
  @optional_items = optional_items
  @origin_context = origin_context
  @payment_intent_data = payment_intent_data
  @payment_method_collection = payment_method_collection
  @payment_method_configuration = payment_method_configuration
  @payment_method_data = payment_method_data
  @payment_method_options = payment_method_options
  @payment_method_types = payment_method_types
  @permissions = permissions
  @phone_number_collection = phone_number_collection
  @redirect_on_completion = redirect_on_completion
  @return_url = return_url
  @saved_payment_method_options = saved_payment_method_options
  @setup_intent_data = setup_intent_data
  @shipping_address_collection = shipping_address_collection
  @shipping_options = shipping_options
  @submit_type = submit_type
  @subscription_data = subscription_data
  @success_url = success_url
  @tax_id_collection = tax_id_collection
  @ui_mode = ui_mode
  @wallet_options = wallet_options
  @checkout_items = checkout_items
end

Instance Attribute Details

#adaptive_pricing ⇒ Object

Settings for price localization with [Adaptive Pricing](docs.stripe.com/payments/checkout/adaptive-pricing).



4421
4422
4423
 
# File 'lib/stripe/resources/checkout/session.rb', line 4421

def adaptive_pricing
  @adaptive_pricing
end

#after_expiration ⇒ Object

Configure actions after a Checkout Session has expired.



4423
4424
4425
 
# File 'lib/stripe/resources/checkout/session.rb', line 4423

def after_expiration
  @after_expiration
end

#allow_promotion_codes ⇒ Object

Enables user redeemable promotion codes.



4425
4426
4427
 
# File 'lib/stripe/resources/checkout/session.rb', line 4425

def allow_promotion_codes
  @allow_promotion_codes
end

#automatic_tax ⇒ Object

Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.



4427
4428
4429
 
# File 'lib/stripe/resources/checkout/session.rb', line 4427

def automatic_tax
  @automatic_tax
end

#billing_address_collection ⇒ Object

Specify whether Checkout should collect the customer’s billing address. Defaults to ‘auto`.



4429
4430
4431
 
# File 'lib/stripe/resources/checkout/session.rb', line 4429

def billing_address_collection
  @billing_address_collection
end

#cancel_url ⇒ Object

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` or `custom`.



4431
4432
4433
 
# File 'lib/stripe/resources/checkout/session.rb', line 4431

def cancel_url
  @cancel_url
end

#checkout_items ⇒ Object

Attribute for param field checkout_items



4576
4577
4578
 
# File 'lib/stripe/resources/checkout/session.rb', line 4576

def checkout_items
  @checkout_items
end

#client_reference_id ⇒ Object

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.



4435
4436
4437
 
# File 'lib/stripe/resources/checkout/session.rb', line 4435

def client_reference_id
  @client_reference_id
end

#consent_collection ⇒ Object

Configure fields for the Checkout Session to gather active consent from customers.



4437
4438
4439
 
# File 'lib/stripe/resources/checkout/session.rb', line 4437

def consent_collection
  @consent_collection
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies). Required in ‘setup` mode when `payment_method_types` is not set.



4439
4440
4441
 
# File 'lib/stripe/resources/checkout/session.rb', line 4439

def currency
  @currency
end

#custom_fields ⇒ Object

Collect additional information from your customer using custom fields. Up to 3 fields are supported.



4441
4442
4443
 
# File 'lib/stripe/resources/checkout/session.rb', line 4441

def custom_fields
  @custom_fields
end

#custom_text ⇒ Object

Display additional text for your customers using custom text.



4443
4444
4445
 
# File 'lib/stripe/resources/checkout/session.rb', line 4443

def custom_text
  @custom_text
end

#customer ⇒ Object

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](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](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`](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.



4455
4456
4457
 
# File 'lib/stripe/resources/checkout/session.rb', line 4455

def customer
  @customer
end

#customer_account ⇒ Object

ID of an existing Account, if one exists. Has the same behavior as ‘customer`.



4457
4458
4459
 
# File 'lib/stripe/resources/checkout/session.rb', line 4457

def 
  @customer_account
end

#customer_creation ⇒ Object

Configure whether a Checkout Session creates a [Customer](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](stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).

Sessions that don’t create Customers instead are grouped by [guest customers](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.



4467
4468
4469
 
# File 'lib/stripe/resources/checkout/session.rb', line 4467

def customer_creation
  @customer_creation
end

#customer_email ⇒ Object

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.



4473
4474
4475
 
# File 'lib/stripe/resources/checkout/session.rb', line 4473

def customer_email
  @customer_email
end

#customer_update ⇒ Object

Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when ‘customer` is provided.



4475
4476
4477
 
# File 'lib/stripe/resources/checkout/session.rb', line 4475

def customer_update
  @customer_update
end

#discounts ⇒ Object

The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.



4477
4478
4479
 
# File 'lib/stripe/resources/checkout/session.rb', line 4477

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



4479
4480
4481
 
# File 'lib/stripe/resources/checkout/session.rb', line 4479

def expand
  @expand
end

#expires_at ⇒ Object

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.



4481
4482
4483
 
# File 'lib/stripe/resources/checkout/session.rb', line 4481

def expires_at
  @expires_at
end

#invoice_creation ⇒ Object

Generate a post-purchase Invoice for one-time payments.



4483
4484
4485
 
# File 'lib/stripe/resources/checkout/session.rb', line 4483

def invoice_creation
  @invoice_creation
end

#line_items ⇒ Object

A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](stripe.com/docs/api/prices). The parameter is required for ‘payment` and `subscription` mode.

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.



4489
4490
4491
 
# File 'lib/stripe/resources/checkout/session.rb', line 4489

def line_items
  @line_items
end

#locale ⇒ Object

The IETF language tag of the locale Checkout is displayed in. If blank or ‘auto`, the browser’s locale is used.



4491
4492
4493
 
# File 'lib/stripe/resources/checkout/session.rb', line 4491

def locale
  @locale
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



4493
4494
4495
 
# File 'lib/stripe/resources/checkout/session.rb', line 4493

def metadata
  @metadata
end

#mode ⇒ Object

The mode of the Checkout Session. Pass ‘subscription` if the Checkout Session includes at least one recurring item.



4495
4496
4497
 
# File 'lib/stripe/resources/checkout/session.rb', line 4495

def mode
  @mode
end

#optional_items ⇒ Object

A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](stripe.com/docs/api/prices).

There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.

For ‘payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.

For ‘subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.



4503
4504
4505
 
# File 'lib/stripe/resources/checkout/session.rb', line 4503

def optional_items
  @optional_items
end

#origin_context ⇒ Object

Where the user is coming from. This informs the optimizations that are applied to the session.



4505
4506
4507
 
# File 'lib/stripe/resources/checkout/session.rb', line 4505

def origin_context
  @origin_context
end

#payment_intent_data ⇒ Object

A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in ‘payment` mode.



4507
4508
4509
 
# File 'lib/stripe/resources/checkout/session.rb', line 4507

def payment_intent_data
  @payment_intent_data
end

#payment_method_collection ⇒ Object

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](stripe.com/docs/payments/checkout/free-trials).



4514
4515
4516
 
# File 'lib/stripe/resources/checkout/session.rb', line 4514

def payment_method_collection
  @payment_method_collection
end

#payment_method_configuration ⇒ Object

The ID of the payment method configuration to use with this Checkout session.



4516
4517
4518
 
# File 'lib/stripe/resources/checkout/session.rb', line 4516

def payment_method_configuration
  @payment_method_configuration
end

#payment_method_data ⇒ Object

This parameter allows you to set some attributes on the payment method created during a Checkout session.



4518
4519
4520
 
# File 'lib/stripe/resources/checkout/session.rb', line 4518

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment-method-specific configuration.



4520
4521
4522
 
# File 'lib/stripe/resources/checkout/session.rb', line 4520

def payment_method_options
  @payment_method_options
end

#payment_method_types ⇒ Object

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](dashboard.stripe.com/settings/payment_methods). See [Dynamic Payment Methods](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.



4532
4533
4534
 
# File 'lib/stripe/resources/checkout/session.rb', line 4532

def payment_method_types
  @payment_method_types
end

#permissions ⇒ Object

This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating ‘embedded` or `custom` sessions.

For specific permissions, please refer to their dedicated subsections, such as ‘permissions.update_shipping_details`.



4536
4537
4538
 
# File 'lib/stripe/resources/checkout/session.rb', line 4536

def permissions
  @permissions
end

#phone_number_collection ⇒ Object

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](stripe.com/docs/payments/checkout/phone-numbers).



4541
4542
4543
 
# File 'lib/stripe/resources/checkout/session.rb', line 4541

def phone_number_collection
  @phone_number_collection
end

#redirect_on_completion ⇒ Object

This parameter applies to ‘ui_mode: embedded`. Learn more about the [redirect behavior](stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.



4543
4544
4545
 
# File 'lib/stripe/resources/checkout/session.rb', line 4543

def redirect_on_completion
  @redirect_on_completion
end

#return_url ⇒ Object

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` or `custom` and redirect-based payment methods are enabled on the session.



4547
4548
4549
 
# File 'lib/stripe/resources/checkout/session.rb', line 4547

def return_url
  @return_url
end

#saved_payment_method_options ⇒ Object

Controls saved payment method settings for the session. Only available in ‘payment` and `subscription` mode.



4549
4550
4551
 
# File 'lib/stripe/resources/checkout/session.rb', line 4549

def saved_payment_method_options
  @saved_payment_method_options
end

#setup_intent_data ⇒ Object

A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in ‘setup` mode.



4551
4552
4553
 
# File 'lib/stripe/resources/checkout/session.rb', line 4551

def setup_intent_data
  @setup_intent_data
end

#shipping_address_collection ⇒ Object

When set, provides configuration for Checkout to collect a shipping address from a customer.



4553
4554
4555
 
# File 'lib/stripe/resources/checkout/session.rb', line 4553

def shipping_address_collection
  @shipping_address_collection
end

#shipping_options ⇒ Object

The shipping rate options to apply to this Session. Up to a maximum of 5.



4555
4556
4557
 
# File 'lib/stripe/resources/checkout/session.rb', line 4555

def shipping_options
  @shipping_options
end

#submit_type ⇒ Object

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` or `subscription` mode. If blank or `auto`, `pay` is used.



4560
4561
4562
 
# File 'lib/stripe/resources/checkout/session.rb', line 4560

def submit_type
  @submit_type
end

#subscription_data ⇒ Object

A subset of parameters to be passed to subscription creation for Checkout Sessions in ‘subscription` mode.



4562
4563
4564
 
# File 'lib/stripe/resources/checkout/session.rb', line 4562

def subscription_data
  @subscription_data
end

#success_url ⇒ Object

The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is ‘embedded` or `custom`. If you’d like to use information from the successful Checkout Session on your page, read the guide on [customizing your success page](stripe.com/docs/payments/checkout/custom-success-page).



4568
4569
4570
 
# File 'lib/stripe/resources/checkout/session.rb', line 4568

def success_url
  @success_url
end

#tax_id_collection ⇒ Object

Controls tax ID collection during checkout.



4570
4571
4572
 
# File 'lib/stripe/resources/checkout/session.rb', line 4570

def tax_id_collection
  @tax_id_collection
end

#ui_mode ⇒ Object

The UI mode of the Session. Defaults to ‘hosted`.



4572
4573
4574
 
# File 'lib/stripe/resources/checkout/session.rb', line 4572

def ui_mode
  @ui_mode
end

#wallet_options ⇒ Object

Wallet-specific configuration.



4574
4575
4576
 
# File 'lib/stripe/resources/checkout/session.rb', line 4574

def wallet_options
  @wallet_options
end