Class: Stripe::Invoice::PayParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/invoice.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(expand: nil, forgive: nil, mandate: nil, off_session: nil, paid_out_of_band: nil, payment_method: nil, source: nil) ⇒ PayParams

Returns a new instance of PayParams.



5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
 
# File 'lib/stripe/resources/invoice.rb', line 5919

def initialize(
  expand: nil,
  forgive: nil,
  mandate: nil,
  off_session: nil,
  paid_out_of_band: nil,
  payment_method: nil,
  source: nil
)
  @expand = expand
  @forgive = forgive
  @mandate = mandate
  @off_session = off_session
  @paid_out_of_band = paid_out_of_band
  @payment_method = payment_method
  @source = source
end

Instance Attribute Details

#expand ⇒ Object

Specifies which fields in the response should be expanded.



5903
5904
5905
 
# File 'lib/stripe/resources/invoice.rb', line 5903

def expand
  @expand
end

#forgive ⇒ Object

In cases where the source used to pay the invoice has insufficient funds, passing ‘forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due.

Passing ‘forgive=false` will fail the charge if the source hasn’t been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to ‘false`.



5907
5908
5909
 
# File 'lib/stripe/resources/invoice.rb', line 5907

def forgive
  @forgive
end

#mandate ⇒ Object

ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice’s default_payment_method or default_source, if set.



5909
5910
5911
 
# File 'lib/stripe/resources/invoice.rb', line 5909

def mandate
  @mandate
end

#off_session ⇒ Object

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to ‘true` (off-session).



5911
5912
5913
 
# File 'lib/stripe/resources/invoice.rb', line 5911

def off_session
  @off_session
end

Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to ‘false`.



5913
5914
5915
 
# File 'lib/stripe/resources/invoice.rb', line 5913

def paid_out_of_band
  @paid_out_of_band
end

#payment_method ⇒ Object

A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.



5915
5916
5917
 
# File 'lib/stripe/resources/invoice.rb', line 5915

def payment_method
  @payment_method
end

#source ⇒ Object

A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.



5917
5918
5919
 
# File 'lib/stripe/resources/invoice.rb', line 5917

def source
  @source
end