Stripe.Resources.InvoicePayment (tiger_stripe v0.3.0)

Copy Markdown View Source

InvoicesInvoicePayment

Invoice Payments represent payments made against invoices. Invoice Payments can be accessed in two ways:

  1. By expanding the payments field on the Invoice resource.
  2. By using the Invoice Payment retrieve and list endpoints.

Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices. This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and monitor the allocation details of the payments.

Summary

Types

payment()
status_transitions()
t()

Functions

expandable_fields()
object_name()

Types

payment()

@type payment() :: %{
  optional(:charge) => String.t() | Stripe.Resources.Charge.t() | nil,
  optional(:payment_intent) =>
    String.t() | Stripe.Resources.PaymentIntent.t() | nil,
  optional(:payment_record) =>
    String.t() | Stripe.Resources.PaymentRecord.t() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • charge - ID of the successful charge for this payment when type is charge.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.
  • payment_intent - ID of the PaymentIntent associated with this payment when type is payment_intent. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
  • payment_record - ID of the PaymentRecord associated with this payment when type is payment_record.
  • type - Type of payment object associated with this invoice payment. Possible values: charge, payment_intent, payment_record.

status_transitions()

@type status_transitions() :: %{
  optional(:canceled_at) => integer() | nil,
  optional(:paid_at) => integer() | nil,
  optional(String.t()) => term()
}
  • canceled_at - The time that the payment was canceled. Format: Unix timestamp. Nullable.
  • paid_at - The time that the payment succeeded. Format: Unix timestamp. Nullable.

t()

@type t() :: %Stripe.Resources.InvoicePayment{
  amount_paid: integer(),
  amount_requested: integer(),
  created: integer(),
  currency: String.t(),
  id: String.t(),
  invoice: String.t() | Stripe.Resources.Invoice.t(),
  is_default: boolean(),
  livemode: boolean(),
  object: String.t(),
  payment: payment(),
  status: String.t(),
  status_transitions: status_transitions()
}
  • amount_paid - Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is paid. This amount can be less than the amount_requested if the PaymentIntent’s amount_received is not sufficient to pay all of the invoices that it is attached to. Nullable.
  • amount_requested - Amount intended to be paid toward this invoice, in cents (or local equivalent)
  • created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Max length: 5000.
  • id - Unique identifier for the object. Max length: 5000.
  • invoice - The invoice that was paid. Expandable.
  • is_default - Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s amount_remaining. The PaymentIntent associated with the default payment can’t be edited or canceled directly.
  • livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: invoice_payment.
  • payment - Expandable.
  • status - The status of the payment, one of open, paid, or canceled. Max length: 5000.
  • status_transitions - Expandable.

Functions

expandable_fields()

object_name()