Class: Stripe::Checkout::SessionCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/checkout/session_create_params.rb

Defined Under Namespace

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, discriminator, discriminator_fields, new, #to_h

Constructor Details

#initialize(adaptive_pricing: nil, after_expiration: nil, allow_promotion_codes: nil, allowed_payment_method_types: nil, automatic_tax: nil, billing_address_collection: nil, branding_settings: 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, excluded_payment_method_types: nil, expand: nil, expires_at: nil, integration_identifier: nil, invoice_creation: nil, line_items: nil, locale: nil, managed_payments: nil, metadata: nil, mode: nil, name_collection: 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, 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) ⇒ SessionCreateParams

Returns a new instance of SessionCreateParams.



2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2675

def initialize(
  adaptive_pricing: nil,
  after_expiration: nil,
  allow_promotion_codes: nil,
  allowed_payment_method_types: nil,
  automatic_tax: nil,
  billing_address_collection: nil,
  branding_settings: 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,
  excluded_payment_method_types: nil,
  expand: nil,
  expires_at: nil,
  integration_identifier: nil,
  invoice_creation: nil,
  line_items: nil,
  locale: nil,
  managed_payments: nil,
  metadata: nil,
  mode: nil,
  name_collection: 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,
  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
)
  @adaptive_pricing = adaptive_pricing
  @after_expiration = after_expiration
  @allow_promotion_codes = allow_promotion_codes
  @allowed_payment_method_types = allowed_payment_method_types
  @automatic_tax = automatic_tax
  @billing_address_collection = billing_address_collection
  @branding_settings = branding_settings
  @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
  @excluded_payment_method_types = excluded_payment_method_types
  @expand = expand
  @expires_at = expires_at
  @integration_identifier = integration_identifier
  @invoice_creation = invoice_creation
  @line_items = line_items
  @locale = locale
  @managed_payments = managed_payments
  @metadata = metadata
  @mode = mode
  @name_collection = name_collection
  @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
  @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
end

Instance Attribute Details

#adaptive_pricing ⇒ Object

Settings for price localization with Adaptive Pricing.



2509
2510
2511
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2509

def adaptive_pricing
  @adaptive_pricing
end

#after_expiration ⇒ Object

Configure actions after a Checkout Session has expired. You can't set this parameter if ui_mode is elements.



2511
2512
2513
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2511

def after_expiration
  @after_expiration
end

#allow_promotion_codes ⇒ Object

Enables user redeemable promotion codes.



2513
2514
2515
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2513

def allow_promotion_codes
  @allow_promotion_codes
end

#allowed_payment_method_types ⇒ Object

A list of the types of payment methods (e.g., card) this Checkout Session can accept.

Unlike payment_method_types, this acts as a filter on the dynamically computed set of eligible payment methods rather than an explicit static list. Only payment methods that are both dynamically eligible and present in this list will be offered to the customer.



2519
2520
2521
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2519

def allowed_payment_method_types
  @allowed_payment_method_types
end

#automatic_tax ⇒ Object

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



2521
2522
2523
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2521

def automatic_tax
  @automatic_tax
end

#billing_address_collection ⇒ Object

Specify whether Checkout should collect the customer's billing address. Defaults to auto.



2523
2524
2525
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2523

def billing_address_collection
  @billing_address_collection
end

#branding_settings ⇒ Object

The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is elements.



2525
2526
2527
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2525

def branding_settings
  @branding_settings
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_page or elements.



2527
2528
2529
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2527

def cancel_url
  @cancel_url
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.



2531
2532
2533
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2531

def client_reference_id
  @client_reference_id
end

#consent_collection ⇒ Object

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



2533
2534
2535
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2533

def consent_collection
  @consent_collection
end

#currency ⇒ Object

Three-letter ISO currency code, in lowercase. Must be a supported currency. Required in setup mode when payment_method_types is not set.



2535
2536
2537
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2535

def currency
  @currency
end

#custom_fields ⇒ Object

Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if ui_mode is elements.



2537
2538
2539
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2537

def custom_fields
  @custom_fields
end

#custom_text ⇒ Object

Display additional text for your customers using custom text. You can't set this parameter if ui_mode is elements.



2539
2540
2541
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2539

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 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.



2551
2552
2553
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2551

def customer
  @customer
end

#customer_account ⇒ Object

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



2553
2554
2555
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2553

def 
  @customer_account
end

#customer_creation ⇒ Object

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.



2563
2564
2565
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2563

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.



2569
2570
2571
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2569

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.



2571
2572
2573
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2571

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.



2573
2574
2575
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2573

def discounts
  @discounts
end

#excluded_payment_method_types ⇒ Object

A list of the types of payment methods (e.g., card) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the Stripe Dashboard.



2575
2576
2577
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2575

def excluded_payment_method_types
  @excluded_payment_method_types
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



2577
2578
2579
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2577

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.



2579
2580
2581
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2579

def expires_at
  @expires_at
end

#integration_identifier ⇒ Object

The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier.



2581
2582
2583
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2581

def integration_identifier
  @integration_identifier
end

#invoice_creation ⇒ Object

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



2583
2584
2585
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2583

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. 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.



2589
2590
2591
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2589

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.



2591
2592
2593
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2591

def locale
  @locale
end

#managed_payments ⇒ Object

Settings for Managed Payments for this Checkout Session and resulting PaymentIntents, Invoices, and Subscriptions.



2593
2594
2595
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2593

def managed_payments
  @managed_payments
end

#metadata ⇒ Object

Set of key-value pairs 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.



2595
2596
2597
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2595

def metadata
  @metadata
end

#mode ⇒ Object

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



2597
2598
2599
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2597

def mode
  @mode
end

#name_collection ⇒ Object

Controls name collection settings for the session.

You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional.

If a Customer is created or provided, the names can be saved to the Customer object as well.



2603
2604
2605
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2603

def name_collection
  @name_collection
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.

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.

You can't set this parameter if ui_mode is elements or form.



2613
2614
2615
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2613

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. You can't set this parameter if ui_mode is elements.



2615
2616
2617
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2615

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.



2617
2618
2619
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2617

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.



2624
2625
2626
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2624

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.



2626
2627
2628
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2626

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.



2628
2629
2630
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2628

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment-method-specific configuration.



2630
2631
2632
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2630

def payment_method_options
  @payment_method_options
end

#permissions ⇒ Object

This property is used to set up permissions for various actions (for example, update) on the CheckoutSession object. Can only be set when creating embedded_page or elements sessions.

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



2634
2635
2636
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2634

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.



2639
2640
2641
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2639

def phone_number_collection
  @phone_number_collection
end

#redirect_on_completion ⇒ Object

This parameter applies to ui_mode: embedded_page. Learn more about the redirect behavior of embedded sessions. Defaults to always.



2641
2642
2643
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2641

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



2645
2646
2647
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2645

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.



2647
2648
2649
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2647

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.



2649
2650
2651
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2649

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.



2651
2652
2653
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2651

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.



2653
2654
2655
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2653

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. You can't set this parameter if ui_mode is elements.



2659
2660
2661
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2659

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.



2661
2662
2663
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2661

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_page or elements. If you'd like to use information from the successful Checkout Session on your page, read the guide on customizing your success page.



2667
2668
2669
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2667

def success_url
  @success_url
end

#tax_id_collection ⇒ Object

Controls tax ID collection during checkout.



2669
2670
2671
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2669

def tax_id_collection
  @tax_id_collection
end

#ui_mode ⇒ Object

The UI mode of the Session. Defaults to hosted_page.



2671
2672
2673
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2671

def ui_mode
  @ui_mode
end

#wallet_options ⇒ Object

Wallet-specific configuration.



2673
2674
2675
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2673

def wallet_options
  @wallet_options
end

Class Method Details

.field_encodings ⇒ Object 



2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2781

def self.field_encodings
  @field_encodings = {
    line_items: {
      kind: :array,
      element: {
        kind: :object,
        fields: { price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } } },
      },
    },
  }
end