Class: Stripe::Checkout::Session::CreateParams::PaymentMethodOptions::Payto::MandateOptions

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/checkout/session.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, amount_type: nil, end_date: nil, payment_schedule: nil, payments_per_period: nil, purpose: nil, start_date: nil) ⇒ MandateOptions

Returns a new instance of MandateOptions.



2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/stripe/resources/checkout/session.rb', line 2436

def initialize(
  amount: nil,
  amount_type: nil,
  end_date: nil,
  payment_schedule: nil,
  payments_per_period: nil,
  purpose: nil,
  start_date: nil
)
  @amount = amount
  @amount_type = amount_type
  @end_date = end_date
  @payment_schedule = payment_schedule
  @payments_per_period = payments_per_period
  @purpose = purpose
  @start_date = start_date
end

Instance Attribute Details

#amount ⇒ Object

Amount that will be collected. It is required when ‘amount_type` is `fixed`.



2422
2423
2424
 
# File 'lib/stripe/resources/checkout/session.rb', line 2422

def amount
  @amount
end

#amount_type ⇒ Object

The type of amount that will be collected. The amount charged must be exact or up to the value of ‘amount` param for `fixed` or `maximum` type respectively.



2424
2425
2426
 
# File 'lib/stripe/resources/checkout/session.rb', line 2424

def amount_type
  @amount_type
end

#end_date ⇒ Object

Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.



2426
2427
2428
 
# File 'lib/stripe/resources/checkout/session.rb', line 2426

def end_date
  @end_date
end

#payment_schedule ⇒ Object

The periodicity at which payments will be collected.



2428
2429
2430
 
# File 'lib/stripe/resources/checkout/session.rb', line 2428

def payment_schedule
  @payment_schedule
end

#payments_per_period ⇒ Object

The number of payments that will be made during a payment period. Defaults to 1 except for when ‘payment_schedule` is `adhoc`. In that case, it defaults to no limit.



2430
2431
2432
 
# File 'lib/stripe/resources/checkout/session.rb', line 2430

def payments_per_period
  @payments_per_period
end

#purpose ⇒ Object

The purpose for which payments are made. Defaults to retail.



2432
2433
2434
 
# File 'lib/stripe/resources/checkout/session.rb', line 2432

def purpose
  @purpose
end

#start_date ⇒ Object

Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.



2434
2435
2436
 
# File 'lib/stripe/resources/checkout/session.rb', line 2434

def start_date
  @start_date
end