Class: Stripe::SetupIntentCreateParams::PaymentMethodOptions::Card::MandateOptions

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/setup_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, 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.



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 669

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.



649
650
651
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 649

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.



651
652
653
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 651

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



653
654
655
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 653

def currency
  @currency
end

#description ⇒ Object

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



655
656
657
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 655

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.



657
658
659
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 657

def end_date
  @end_date
end

#interval ⇒ Object

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



659
660
661
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 659

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



661
662
663
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 661

def interval_count
  @interval_count
end

#reference ⇒ Object

Unique identifier for the mandate or subscription.



663
664
665
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 663

def reference
  @reference
end

#start_date ⇒ Object

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



665
666
667
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 665

def start_date
  @start_date
end

#supported_types ⇒ Object

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



667
668
669
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 667

def supported_types
  @supported_types
end