Class: Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions

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



7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
 
# File 'lib/stripe/resources/payment_intent.rb', line 7212

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.



7194
7195
7196
 
# File 'lib/stripe/resources/payment_intent.rb', line 7194

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.



7196
7197
7198
 
# File 'lib/stripe/resources/payment_intent.rb', line 7196

def amount_type
  @amount_type
end

#description ⇒ Object

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



7198
7199
7200
 
# File 'lib/stripe/resources/payment_intent.rb', line 7198

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.



7200
7201
7202
 
# File 'lib/stripe/resources/payment_intent.rb', line 7200

def end_date
  @end_date
end

#interval ⇒ Object

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



7202
7203
7204
 
# File 'lib/stripe/resources/payment_intent.rb', line 7202

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



7204
7205
7206
 
# File 'lib/stripe/resources/payment_intent.rb', line 7204

def interval_count
  @interval_count
end

#reference ⇒ Object

Unique identifier for the mandate or subscription.



7206
7207
7208
 
# File 'lib/stripe/resources/payment_intent.rb', line 7206

def reference
  @reference
end

#start_date ⇒ Object

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



7208
7209
7210
 
# File 'lib/stripe/resources/payment_intent.rb', line 7208

def start_date
  @start_date
end

#supported_types ⇒ Object

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



7210
7211
7212
 
# File 'lib/stripe/resources/payment_intent.rb', line 7210

def supported_types
  @supported_types
end