Class: Stripe::CustomerSession::Components::PaymentElement::Features

Inherits:
StripeObject
  • Object
show all
Defined in:
lib/stripe/resources/customer_session.rb

Constant Summary

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#payment_method_allow_redisplay_filters ⇒ Object (readonly)

A list of allow_redisplay values that controls which saved payment methods the 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"].



114
115
116
 
# File 'lib/stripe/resources/customer_session.rb', line 114

def payment_method_allow_redisplay_filters
  @payment_method_allow_redisplay_filters
end

#payment_method_redisplay ⇒ Object (readonly)

Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to disabled.



116
117
118
 
# File 'lib/stripe/resources/customer_session.rb', line 116

def payment_method_redisplay
  @payment_method_redisplay
end

#payment_method_redisplay_limit ⇒ Object (readonly)

Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to 3. The maximum redisplay limit is 10.



118
119
120
 
# File 'lib/stripe/resources/customer_session.rb', line 118

def payment_method_redisplay_limit
  @payment_method_redisplay_limit
end

#payment_method_remove ⇒ Object (readonly)

Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to disabled.

Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the customer object from that PaymentMethod.



122
123
124
 
# File 'lib/stripe/resources/customer_session.rb', line 122

def payment_method_remove
  @payment_method_remove
end

#payment_method_save ⇒ Object (readonly)

Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to disabled.

If a customer checks the box, the allow_redisplay value on the PaymentMethod is set to 'always' at confirmation time. For PaymentIntents, the setup_future_usage value is also set to the value defined in payment_method_save_usage.



126
127
128
 
# File 'lib/stripe/resources/customer_session.rb', line 126

def payment_method_save
  @payment_method_save
end

#payment_method_save_usage ⇒ Object (readonly)

When using PaymentIntents and the customer checks the save checkbox, this field determines the setup_future_usage value used to confirm the PaymentIntent.

When using SetupIntents, directly configure the usage value on SetupIntent creation.



130
131
132
 
# File 'lib/stripe/resources/customer_session.rb', line 130

def payment_method_save_usage
  @payment_method_save_usage
end

Class Method Details

.field_remappings ⇒ Object 



136
137
138
 
# File 'lib/stripe/resources/customer_session.rb', line 136

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



132
133
134
 
# File 'lib/stripe/resources/customer_session.rb', line 132

def self.inner_class_types
  @inner_class_types = {}
end