Class: Stripe::Checkout::SessionService::CreateParams

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/checkout/session_service.rb

Defined Under Namespace

Classes: AdaptivePricing, AfterExpiration, AutomaticTax, 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, 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) ⇒ CreateParams

Returns a new instance of CreateParams.



2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2303

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,
  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
  @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
  @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).



2150
2151
2152
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2150

def adaptive_pricing
  @adaptive_pricing
end

#after_expiration ⇒ Object

Configure actions after a Checkout Session has expired.



2152
2153
2154
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2152

def after_expiration
  @after_expiration
end

#allow_promotion_codes ⇒ Object

Enables user redeemable promotion codes.



2154
2155
2156
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2154

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.



2156
2157
2158
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2156

def automatic_tax
  @automatic_tax
end

#billing_address_collection ⇒ Object

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



2158
2159
2160
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2158

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



2160
2161
2162
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2160

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.



2164
2165
2166
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2164

def client_reference_id
  @client_reference_id
end

#consent_collection ⇒ Object

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



2166
2167
2168
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2166

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.



2168
2169
2170
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2168

def currency
  @currency
end

#custom_fields ⇒ Object

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



2170
2171
2172
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2170

def custom_fields
  @custom_fields
end

#custom_text ⇒ Object

Display additional text for your customers using custom text.



2172
2173
2174
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2172

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.



2184
2185
2186
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2184

def customer
  @customer
end

#customer_account ⇒ Object

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



2186
2187
2188
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2186

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.



2196
2197
2198
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2196

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.



2202
2203
2204
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2202

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.



2204
2205
2206
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2204

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.



2206
2207
2208
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2206

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



2208
2209
2210
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2208

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.



2210
2211
2212
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2210

def expires_at
  @expires_at
end

#invoice_creation ⇒ Object

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



2212
2213
2214
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2212

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.



2218
2219
2220
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2218

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.



2220
2221
2222
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2220

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



2222
2223
2224
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2222

def metadata
  @metadata
end

#mode ⇒ Object

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



2224
2225
2226
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2224

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.



2232
2233
2234
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2232

def optional_items
  @optional_items
end

#payment_intent_data ⇒ Object

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



2234
2235
2236
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2234

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



2241
2242
2243
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2241

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.



2243
2244
2245
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2243

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.



2245
2246
2247
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2245

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment-method-specific configuration.



2247
2248
2249
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2247

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.



2259
2260
2261
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2259

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



2263
2264
2265
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2263

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



2268
2269
2270
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2268

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



2270
2271
2272
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2270

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.



2274
2275
2276
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2274

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.



2276
2277
2278
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2276

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.



2278
2279
2280
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2278

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.



2280
2281
2282
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2280

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.



2282
2283
2284
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2282

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.



2287
2288
2289
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2287

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.



2289
2290
2291
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2289

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



2295
2296
2297
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2295

def success_url
  @success_url
end

#tax_id_collection ⇒ Object

Controls tax ID collection during checkout.



2297
2298
2299
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2297

def tax_id_collection
  @tax_id_collection
end

#ui_mode ⇒ Object

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



2299
2300
2301
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2299

def ui_mode
  @ui_mode
end

#wallet_options ⇒ Object

Wallet-specific configuration.



2301
2302
2303
 
# File 'lib/stripe/services/checkout/session_service.rb', line 2301

def wallet_options
  @wallet_options
end