Class: Stripe::SetupIntentCreateParams::PaymentMethodOptions::Payto::MandateOptions

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #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.



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 979

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.



965
966
967
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 965

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. Defaults to maximum.



967
968
969
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 967

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.



969
970
971
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 969

def end_date
  @end_date
end

#payment_schedule ⇒ Object

The periodicity at which payments will be collected. Defaults to adhoc.



971
972
973
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 971

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.



973
974
975
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 973

def payments_per_period
  @payments_per_period
end

#purpose ⇒ Object

The purpose for which payments are made. Has a default value based on your merchant category code.



975
976
977
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 975

def purpose
  @purpose
end

#start_date ⇒ Object

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



977
978
979
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 977

def start_date
  @start_date
end