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

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



1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'lib/stripe/services/checkout/session_service.rb', line 1451

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



1437
1438
1439
 
# File 'lib/stripe/services/checkout/session_service.rb', line 1437

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.



1439
1440
1441
 
# File 'lib/stripe/services/checkout/session_service.rb', line 1439

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.



1441
1442
1443
 
# File 'lib/stripe/services/checkout/session_service.rb', line 1441

def end_date
  @end_date
end

#payment_schedule ⇒ Object

The periodicity at which payments will be collected.



1443
1444
1445
 
# File 'lib/stripe/services/checkout/session_service.rb', line 1443

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.



1445
1446
1447
 
# File 'lib/stripe/services/checkout/session_service.rb', line 1445

def payments_per_period
  @payments_per_period
end

#purpose ⇒ Object

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



1447
1448
1449
 
# File 'lib/stripe/services/checkout/session_service.rb', line 1447

def purpose
  @purpose
end

#start_date ⇒ Object

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



1449
1450
1451
 
# File 'lib/stripe/services/checkout/session_service.rb', line 1449

def start_date
  @start_date
end