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.



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1102

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

#amount ⇒ Object

Amount to be charged for future payments.



1084
1085
1086
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1084

def amount
  @amount
end

#amount_type ⇒ Object

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.



1086
1087
1088
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1086

def amount_type
  @amount_type
end

#description ⇒ Object

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



1088
1089
1090
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1088

def description
  @description
end

#end_date ⇒ Object

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.



1090
1091
1092
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1090

def end_date
  @end_date
end

#interval ⇒ Object

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



1092
1093
1094
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1092

def interval
  @interval
end

#interval_count ⇒ Object

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



1094
1095
1096
 
# File 'lib/stripe/params/payment_intent_update_params.rb', line 1094

def interval_count
  @interval_count
end

#reference ⇒ Object

Unique identifier for the mandate or subscription.



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

def reference
  @reference
end

#start_date ⇒ Object

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



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

def start_date
  @start_date
end

#supported_types ⇒ Object

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



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

def supported_types
  @supported_types
end