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, NameCollection, 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, 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, invoice_creation: nil, line_items: nil, locale: 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, 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) ⇒ SessionCreateParams

Returns a new instance of SessionCreateParams.



2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2556

def initialize(
  adaptive_pricing: nil,
  after_expiration: nil,
  allow_promotion_codes: 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,
  invoice_creation: nil,
  line_items: nil,
  locale: 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,
  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
)
  @adaptive_pricing = adaptive_pricing
  @after_expiration = after_expiration
  @allow_promotion_codes = allow_promotion_codes
  @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
  @invoice_creation = invoice_creation
  @line_items = line_items
  @locale = locale
  @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
  @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
end

Instance Attribute Details

#adaptive_pricing ⇒ Object

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



2386
2387
2388
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2386

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



2388
2389
2390
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2388

def after_expiration
  @after_expiration
end

#allow_promotion_codes ⇒ Object

Enables user redeemable promotion codes.



2390
2391
2392
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2390

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.



2392
2393
2394
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2392

def automatic_tax
  @automatic_tax
end

#billing_address_collection ⇒ Object

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



2394
2395
2396
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2394

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



2396
2397
2398
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2396

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



2398
2399
2400
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2398

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.



2402
2403
2404
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2402

def client_reference_id
  @client_reference_id
end

#consent_collection ⇒ Object

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



2404
2405
2406
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2404

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.



2406
2407
2408
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2406

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



2408
2409
2410
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2408

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



2410
2411
2412
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2410

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](docs.stripe.com/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](docs.stripe.com/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`](docs.stripe.com/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.



2422
2423
2424
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2422

def customer
  @customer
end

#customer_account ⇒ Object

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



2424
2425
2426
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2424

def 
  @customer_account
end

#customer_creation ⇒ Object

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

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



2434
2435
2436
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2434

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.



2440
2441
2442
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2440

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.



2442
2443
2444
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2442

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.



2444
2445
2446
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2444

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](dashboard.stripe.com/settings/payment_methods).



2446
2447
2448
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2446

def excluded_payment_method_types
  @excluded_payment_method_types
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



2448
2449
2450
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2448

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.



2450
2451
2452
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2450

def expires_at
  @expires_at
end

#invoice_creation ⇒ Object

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



2452
2453
2454
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2452

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](docs.stripe.com/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.



2458
2459
2460
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2458

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.



2460
2461
2462
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2460

def locale
  @locale
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/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`.



2462
2463
2464
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2462

def metadata
  @metadata
end

#mode ⇒ Object

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



2464
2465
2466
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2464

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](docs.stripe.com/api/customers) is created or provided, the names can be saved to the Customer object as well.

You can’t set this parameter if ‘ui_mode` is `custom`.



2472
2473
2474
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2472

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](docs.stripe.com/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.

You can’t set this parameter if ‘ui_mode` is `custom`.



2482
2483
2484
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2482

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



2484
2485
2486
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2484

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.



2486
2487
2488
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2486

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



2493
2494
2495
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2493

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.



2495
2496
2497
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2495

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.



2497
2498
2499
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2497

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment-method-specific configuration.



2499
2500
2501
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2499

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](docs.stripe.com/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.



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

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



2515
2516
2517
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2515

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



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

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](docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.



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

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.



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

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.



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

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.



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

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.



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

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.



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

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



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

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.



2542
2543
2544
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2542

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](docs.stripe.com/payments/checkout/custom-success-page).



2548
2549
2550
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2548

def success_url
  @success_url
end

#tax_id_collection ⇒ Object

Controls tax ID collection during checkout.



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

def tax_id_collection
  @tax_id_collection
end

#ui_mode ⇒ Object

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



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

def ui_mode
  @ui_mode
end

#wallet_options ⇒ Object

Wallet-specific configuration.



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

def wallet_options
  @wallet_options
end