Class: Stripe::SetupIntentConfirmParams::PaymentMethodOptions::Card::MandateOptions

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #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.



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 710

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, specified in the presentment currency.



690
691
692
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 690

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.



692
693
694
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 692

def amount_type
  @amount_type
end

#currency ⇒ Object

Currency in which future payments will be charged. Three-letter ISO currency code, in lowercase. Must be a supported currency.



694
695
696
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 694

def currency
  @currency
end

#description ⇒ Object

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



696
697
698
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 696

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.



698
699
700
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 698

def end_date
  @end_date
end

#interval ⇒ Object

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



700
701
702
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 700

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.



702
703
704
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 702

def interval_count
  @interval_count
end

#reference ⇒ Object

Unique identifier for the mandate or subscription.



704
705
706
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 704

def reference
  @reference
end

#start_date ⇒ Object

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



706
707
708
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 706

def start_date
  @start_date
end

#supported_types ⇒ Object

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



708
709
710
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 708

def supported_types
  @supported_types
end