Class: Stripe::SetupIntentConfirmParams::PaymentMethodOptions::Payto::MandateOptions

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



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1072

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.



1058
1059
1060
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1058

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.



1060
1061
1062
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1060

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.



1062
1063
1064
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1062

def end_date
  @end_date
end

#payment_schedule ⇒ Object

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



1064
1065
1066
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1064

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.



1066
1067
1068
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1066

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.



1068
1069
1070
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1068

def purpose
  @purpose
end

#start_date ⇒ Object

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



1070
1071
1072
 
# File 'lib/stripe/params/setup_intent_confirm_params.rb', line 1070

def start_date
  @start_date
end