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

attr_accessor, coerce_params, coerce_value, field_encodings, new, #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.



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 814

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, specified in the presentment currency.



794
795
796
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 794

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.



796
797
798
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 796

def amount_type
  @amount_type
end

#currency ⇒ Object

Currency in which future payments will be charged. Three-letter ISO currency code, in lowercase. Must be a supported currency.



798
799
800
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 798

def currency
  @currency
end

#description ⇒ Object

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



800
801
802
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 800

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.



802
803
804
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 802

def end_date
  @end_date
end

#interval ⇒ Object

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



804
805
806
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 804

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.



806
807
808
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 806

def interval_count
  @interval_count
end

#reference ⇒ Object

Unique identifier for the mandate or subscription.



808
809
810
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 808

def reference
  @reference
end

#start_date ⇒ Object

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



810
811
812
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 810

def start_date
  @start_date
end

#supported_types ⇒ Object

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



812
813
814
 
# File 'lib/stripe/params/setup_intent_create_params.rb', line 812

def supported_types
  @supported_types
end