Class: Stripe::SetupIntent::UpdateParams::PaymentMethodOptions::Card::MandateOptions

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/setup_intent.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, amount_type: nil, currency: 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.



2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
 
# File 'lib/stripe/resources/setup_intent.rb', line 2598

def initialize(
  amount: nil,
  amount_type: nil,
  currency: 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
  @currency = currency
  @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.



2569
2570
2571
 
# File 'lib/stripe/resources/setup_intent.rb', line 2569

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.



2572
2573
2574
 
# File 'lib/stripe/resources/setup_intent.rb', line 2572

def amount_type
  @amount_type
end

#currency ⇒ Object

Currency in which future payments will be charged. Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



2575
2576
2577
 
# File 'lib/stripe/resources/setup_intent.rb', line 2575

def currency
  @currency
end

#description ⇒ Object

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



2578
2579
2580
 
# File 'lib/stripe/resources/setup_intent.rb', line 2578

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.



2581
2582
2583
 
# File 'lib/stripe/resources/setup_intent.rb', line 2581

def end_date
  @end_date
end

#interval ⇒ Object

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



2584
2585
2586
 
# File 'lib/stripe/resources/setup_intent.rb', line 2584

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



2587
2588
2589
 
# File 'lib/stripe/resources/setup_intent.rb', line 2587

def interval_count
  @interval_count
end

#reference ⇒ Object

Unique identifier for the mandate or subscription.



2590
2591
2592
 
# File 'lib/stripe/resources/setup_intent.rb', line 2590

def reference
  @reference
end

#start_date ⇒ Object

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



2593
2594
2595
 
# File 'lib/stripe/resources/setup_intent.rb', line 2593

def start_date
  @start_date
end

#supported_types ⇒ Object

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



2596
2597
2598
 
# File 'lib/stripe/resources/setup_intent.rb', line 2596

def supported_types
  @supported_types
end