Class: Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card::MandateOptions

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/payment_intent_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, amount_type: 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.



5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5734

def initialize(
  amount: nil,
  amount_type: 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
  @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.



5716
5717
5718
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5716

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.



5718
5719
5720
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5718

def amount_type
  @amount_type
end

#description ⇒ Object

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



5720
5721
5722
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5720

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.



5722
5723
5724
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5722

def end_date
  @end_date
end

#interval ⇒ Object

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



5724
5725
5726
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5724

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



5726
5727
5728
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5726

def interval_count
  @interval_count
end

#reference ⇒ Object

Unique identifier for the mandate or subscription.



5728
5729
5730
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5728

def reference
  @reference
end

#start_date ⇒ Object

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



5730
5731
5732
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5730

def start_date
  @start_date
end

#supported_types ⇒ Object

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



5732
5733
5734
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5732

def supported_types
  @supported_types
end