Class: Stripe::PaymentIntentUpdateParams::PaymentMethodOptions::Card::MandateOptions

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, amount_type: nil, description: nil, end_date: nil, interval: nil, interval_count: nil, reference: nil, start_date: nil, supported_types: nil) ⇒ MandateOptions

Returns a new instance of MandateOptions.



1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1115

def initialize(
  amount: nil,
  amount_type: nil,
  description: nil,
  end_date: nil,
  interval: nil,
  interval_count: nil,
  reference: nil,
  start_date: nil,
  supported_types: nil
)
  @amount = amount
  @amount_type = amount_type
  @description = description
  @end_date = end_date
  @interval = interval
  @interval_count = interval_count
  @reference = reference
  @start_date = start_date
  @supported_types = supported_types
end

Instance Attribute Details

#amountObject

Amount to be charged for future payments.



1097
1098
1099
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1097

def amount
  @amount
end

#amount_typeObject

One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.



1099
1100
1101
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1099

def amount_type
  @amount_type
end

#descriptionObject

A description of the mandate or subscription that is meant to be displayed to the customer.



1101
1102
1103
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1101

def description
  @description
end

#end_dateObject

End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.



1103
1104
1105
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1103

def end_date
  @end_date
end

#intervalObject

Specifies payment frequency. One of day, week, month, year, or sporadic.



1105
1106
1107
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1105

def interval
  @interval
end

#interval_countObject

The number of intervals between payments. For example, ‘interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.



1107
1108
1109
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1107

def interval_count
  @interval_count
end

#referenceObject

Unique identifier for the mandate or subscription.



1109
1110
1111
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1109

def reference
  @reference
end

#start_dateObject

Start date of the mandate or subscription. Start date should not be lesser than yesterday.



1111
1112
1113
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1111

def start_date
  @start_date
end

#supported_typesObject

Specifies the type of mandates supported. Possible values are india.



1113
1114
1115
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1113

def supported_types
  @supported_types
end