Class: Stripe::SetupIntentCreateParams::PaymentMethodOptions::Card::MandateOptions

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/setup_intent_create_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.



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 689

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.



669
670
671
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 669

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.



671
672
673
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 671

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



673
674
675
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 673

def currency
  @currency
end

#description ⇒ Object

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



675
676
677
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 675

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.



677
678
679
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 677

def end_date
  @end_date
end

#interval ⇒ Object

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



679
680
681
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 679

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



681
682
683
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 681

def interval_count
  @interval_count
end

#reference ⇒ Object

Unique identifier for the mandate or subscription.



683
684
685
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 683

def reference
  @reference
end

#start_date ⇒ Object

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



685
686
687
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 685

def start_date
  @start_date
end

#supported_types ⇒ Object

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



687
688
689
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 687

def supported_types
  @supported_types
end