Search documentation of stripe_elixir

# StripeElixir.Params.InvoicePayParams (stripe_elixir v0.1.0)

Copy Markdown View Source

Parameters for invoice pay.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.InvoicePayParams{
      expand: [String.t()] | nil,
      forgive: boolean() | nil,
      mandate: map() | nil,
      off_session: boolean() | nil,
      paid_out_of_band: boolean() | nil,
      payment_method: String.t() | nil,
      source: String.t() | nil
    }

- `expand` - Specifies which fields in the response should be expanded.
- `forgive` - 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`.

- `mandate` - 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.
- `off_session` - Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).
- `paid_out_of_band` - Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.
- `payment_method` - A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid. Max length: 5000.
- `source` - 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. Max length: 5000.