Class: Stripe::SetupIntentUpdateParams::PaymentMethodOptions::Card::MandateOptions

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, amount_type: nil, currency: nil, description: nil, end_date: nil, interval: nil, interval_count: nil, reference: nil, start_date: nil, supported_types: nil) ⇒ MandateOptions

Returns a new instance of MandateOptions.



636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 636

def initialize(
  amount: nil,
  amount_type: nil,
  currency: nil,
  description: nil,
  end_date: nil,
  interval: nil,
  interval_count: nil,
  reference: nil,
  start_date: nil,
  supported_types: nil
)
  @amount = amount
  @amount_type = amount_type
  @currency = currency
  @description = description
  @end_date = end_date
  @interval = interval
  @interval_count = interval_count
  @reference = reference
  @start_date = start_date
  @supported_types = supported_types
end

Instance Attribute Details

#amount ⇒ Object

Amount to be charged for future payments.



616
617
618
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 616

def amount
  @amount
end

#amount_type ⇒ Object

One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.



618
619
620
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 618

def amount_type
  @amount_type
end

#currency ⇒ Object

Currency in which future payments will be charged. Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



620
621
622
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 620

def currency
  @currency
end

#description ⇒ Object

A description of the mandate or subscription that is meant to be displayed to the customer.



622
623
624
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 622

def description
  @description
end

#end_date ⇒ Object

End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.



624
625
626
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 624

def end_date
  @end_date
end

#interval ⇒ Object

Specifies payment frequency. One of day, week, month, year, or sporadic.



626
627
628
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 626

def interval
  @interval
end

#interval_count ⇒ Object

The number of intervals between payments. For example, ‘interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.



628
629
630
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 628

def interval_count
  @interval_count
end

#reference ⇒ Object

Unique identifier for the mandate or subscription.



630
631
632
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 630

def reference
  @reference
end

#start_date ⇒ Object

Start date of the mandate or subscription. Start date should not be lesser than yesterday.



632
633
634
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 632

def start_date
  @start_date
end

#supported_types ⇒ Object

Specifies the type of mandates supported. Possible values are india.



634
635
636
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 634

def supported_types
  @supported_types
end