Class: Stripe::Checkout::SessionCreateParams::PaymentMethodOptions::Pix::MandateOptions

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/checkout/session_create_params.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, amount_includes_iof: nil, amount_type: nil, currency: nil, end_date: nil, payment_schedule: nil, reference: nil, start_date: nil) ⇒ MandateOptions

Returns a new instance of MandateOptions.



1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1705

def initialize(
  amount: nil,
  amount_includes_iof: nil,
  amount_type: nil,
  currency: nil,
  end_date: nil,
  payment_schedule: nil,
  reference: nil,
  start_date: nil
)
  @amount = amount
  @amount_includes_iof = amount_includes_iof
  @amount_type = amount_type
  @currency = currency
  @end_date = end_date
  @payment_schedule = payment_schedule
  @reference = reference
  @start_date = start_date
end

Instance Attribute Details

#amount ⇒ Object

Amount to be charged for future payments. Required when ‘amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.



1689
1690
1691
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1689

def amount
  @amount
end

#amount_includes_iof ⇒ Object

Determines if the amount includes the IOF tax. Defaults to ‘never`.



1691
1692
1693
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1691

def amount_includes_iof
  @amount_includes_iof
end

#amount_type ⇒ Object

Type of amount. Defaults to ‘maximum`.



1693
1694
1695
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1693

def amount_type
  @amount_type
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Only ‘brl` is supported currently.



1695
1696
1697
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1695

def currency
  @currency
end

#end_date ⇒ Object

Date when the mandate expires and no further payments will be charged, in ‘YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.



1697
1698
1699
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1697

def end_date
  @end_date
end

#payment_schedule ⇒ Object

Schedule at which the future payments will be charged. Defaults to ‘weekly`.



1699
1700
1701
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1699

def payment_schedule
  @payment_schedule
end

#reference ⇒ Object

Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.



1701
1702
1703
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1701

def reference
  @reference
end

#start_date ⇒ Object

Start date of the mandate, in ‘YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.



1703
1704
1705
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 1703

def start_date
  @start_date
end