Class: Stripe::CustomerSessionCreateParams::Components::MobilePaymentElement::Features

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/customer_session_create_params.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(payment_method_allow_redisplay_filters: nil, payment_method_redisplay: nil, payment_method_remove: nil, payment_method_save: nil, payment_method_save_allow_redisplay_override: nil) ⇒ Features 



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/stripe/params/customer_session_create_params.rb', line 64

def initialize(
  payment_method_allow_redisplay_filters: nil,
  payment_method_redisplay: nil,
  payment_method_remove: nil,
  payment_method_save: nil,
  payment_method_save_allow_redisplay_override: nil
)
  @payment_method_allow_redisplay_filters = payment_method_allow_redisplay_filters
  @payment_method_redisplay = payment_method_redisplay
  @payment_method_remove = payment_method_remove
  @payment_method_save = payment_method_save
  @payment_method_save_allow_redisplay_override = payment_method_save_allow_redisplay_override
end

Instance Attribute Details

#payment_method_allow_redisplay_filters ⇒ Object

A list of [‘allow_redisplay`](docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the mobile payment element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.

If not specified, defaults to [“always”]. In order to display all saved payment methods, specify [“always”, “limited”, “unspecified”].



48
49
50
 
# File 'lib/stripe/params/customer_session_create_params.rb', line 48

def payment_method_allow_redisplay_filters
  @payment_method_allow_redisplay_filters
end

#payment_method_redisplay ⇒ Object

Controls whether or not the mobile payment element shows saved payment methods.



50
51
52
 
# File 'lib/stripe/params/customer_session_create_params.rb', line 50

def payment_method_redisplay
  @payment_method_redisplay
end

#payment_method_remove ⇒ Object

Controls whether the mobile payment element displays the option to remove a saved payment method.“

Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [‘customer` object](docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](docs.stripe.com/api/payment_methods).



54
55
56
 
# File 'lib/stripe/params/customer_session_create_params.rb', line 54

def payment_method_remove
  @payment_method_remove
end

#payment_method_save ⇒ Object

Controls whether the mobile payment element displays a checkbox offering to save a new payment method.

If a customer checks the box, the [‘allow_redisplay`](docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `’always’‘ at confirmation time. For PaymentIntents, the [`setup_future_usage`](docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.



58
59
60
 
# File 'lib/stripe/params/customer_session_create_params.rb', line 58

def payment_method_save
  @payment_method_save
end

#payment_method_save_allow_redisplay_override ⇒ Object

Allows overriding the value of allow_override when saving a new payment method when payment_method_save is set to disabled. Use values: “always”, “limited”, or “unspecified”.

If not specified, defaults to ‘nil` (no override value).



62
63
64
 
# File 'lib/stripe/params/customer_session_create_params.rb', line 62

def payment_method_save_allow_redisplay_override
  @payment_method_save_allow_redisplay_override
end