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

Method Summary

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #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`](docs.stripe.com/api/payment_methods/object#payment_method_object-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”].



30
31
32
 
# File 'lib/stripe/resources/customer_session.rb', line 30

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



32
33
34
 
# File 'lib/stripe/resources/customer_session.rb', line 32

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



34
35
36
 
# File 'lib/stripe/resources/customer_session.rb', line 34

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](docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](docs.stripe.com/api/payment_methods).



38
39
40
 
# File 'lib/stripe/resources/customer_session.rb', line 38

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



42
43
44
 
# File 'lib/stripe/resources/customer_session.rb', line 42

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`](docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.

When using SetupIntents, directly configure the [‘usage`](docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.



46
47
48
 
# File 'lib/stripe/resources/customer_session.rb', line 46

def payment_method_save_usage
  @payment_method_save_usage
end