Class: Stripe::PaymentIntentCreateParams::PaymentMethodOptions::Payto::MandateOptions

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/payment_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) ⇒ MandateOptions

Returns a new instance of MandateOptions.



4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 4872

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

Instance Attribute Details

#amount ⇒ Object

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



4860
4861
4862
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 4860

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.



4862
4863
4864
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 4862

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.



4864
4865
4866
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 4864

def end_date
  @end_date
end

#payment_schedule ⇒ Object

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



4866
4867
4868
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 4866

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.



4868
4869
4870
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 4868

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.



4870
4871
4872
 
# File 'lib/stripe/params/payment_intent_create_params.rb', line 4870

def purpose
  @purpose
end