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.



5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5678

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.



5660
5661
5662
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5660

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.



5662
5663
5664
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5662

def amount_type
  @amount_type
end

#description ⇒ Object

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



5664
5665
5666
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5664

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.



5666
5667
5668
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5666

def end_date
  @end_date
end

#interval ⇒ Object

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



5668
5669
5670
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5668

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



5670
5671
5672
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5670

def interval_count
  @interval_count
end

#reference ⇒ Object

Unique identifier for the mandate or subscription.



5672
5673
5674
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5672

def reference
  @reference
end

#start_date ⇒ Object

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



5674
5675
5676
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5674

def start_date
  @start_date
end

#supported_types ⇒ Object

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



5676
5677
5678
 
# File 'lib/stripe/services/payment_intent_service.rb', line 5676

def supported_types
  @supported_types
end