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.



1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
 
# File 'lib/stripe/resources/invoice.rb', line 1966

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.



1950
1951
1952
 
# File 'lib/stripe/resources/invoice.rb', line 1950

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



1954
1955
1956
 
# File 'lib/stripe/resources/invoice.rb', line 1954

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.



1956
1957
1958
 
# File 'lib/stripe/resources/invoice.rb', line 1956

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



1958
1959
1960
 
# File 'lib/stripe/resources/invoice.rb', line 1958

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



1960
1961
1962
 
# File 'lib/stripe/resources/invoice.rb', line 1960

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.



1962
1963
1964
 
# File 'lib/stripe/resources/invoice.rb', line 1962

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.



1964
1965
1966
 
# File 'lib/stripe/resources/invoice.rb', line 1964

def source
  @source
end