Class: Stripe::PaymentIntentCreateParams::PaymentMethodOptions::Card::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

#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



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
# File 'lib/stripe/params/payment_intent_create_params.rb', line 1155

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.



1137
1138
1139
# File 'lib/stripe/params/payment_intent_create_params.rb', line 1137

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.



1139
1140
1141
# File 'lib/stripe/params/payment_intent_create_params.rb', line 1139

def amount_type
  @amount_type
end

#descriptionObject

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



1141
1142
1143
# File 'lib/stripe/params/payment_intent_create_params.rb', line 1141

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.



1143
1144
1145
# File 'lib/stripe/params/payment_intent_create_params.rb', line 1143

def end_date
  @end_date
end

#intervalObject

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



1145
1146
1147
# File 'lib/stripe/params/payment_intent_create_params.rb', line 1145

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`.



1147
1148
1149
# File 'lib/stripe/params/payment_intent_create_params.rb', line 1147

def interval_count
  @interval_count
end

#referenceObject

Unique identifier for the mandate or subscription.



1149
1150
1151
# File 'lib/stripe/params/payment_intent_create_params.rb', line 1149

def reference
  @reference
end

#start_dateObject

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



1151
1152
1153
# File 'lib/stripe/params/payment_intent_create_params.rb', line 1151

def start_date
  @start_date
end

#supported_typesObject

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



1153
1154
1155
# File 'lib/stripe/params/payment_intent_create_params.rb', line 1153

def supported_types
  @supported_types
end