tiger_stripe

# File generated from our OpenAPI spec
defmodule Stripe.Resources.InvoicePayment do
  @moduledoc """
  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](https://api.stripe.com#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.
  """

  @typedoc """
  * `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](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). 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.
  """
  @type t :: %__MODULE__{
          amount_paid: integer(),
          amount_requested: integer(),
          created: integer(),
          currency: String.t(),
          id: String.t(),
          invoice: map(),
          is_default: boolean(),
          livemode: boolean(),
          object: String.t(),
          payment: map(),
          status: String.t(),
          status_transitions: map()
        }

  defstruct [
    :amount_paid,
    :amount_requested,
    :created,
    :currency,
    :id,
    :invoice,
    :is_default,
    :livemode,
    :object,
    :payment,
    :status,
    :status_transitions
  ]

  @object_name "invoice_payment"
  def object_name, do: @object_name

  def expandable_fields, do: ["invoice", "payment", "status_transitions"]

  defmodule Payment do
    @moduledoc false

    @typedoc """
    * `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`.
    """
    @type t :: %__MODULE__{
            charge: String.t() | map() | nil,
            payment_intent: String.t() | map() | nil,
            payment_record: String.t() | map() | nil,
            type: String.t() | nil
          }
    defstruct [:charge, :payment_intent, :payment_record, :type]
  end

  defmodule StatusTransitions do
    @moduledoc false

    @typedoc """
    * `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.
    """
    @type t :: %__MODULE__{
            canceled_at: integer() | nil,
            paid_at: integer() | nil
          }
    defstruct [:canceled_at, :paid_at]
  end

  def __inner_types__ do
    %{
      "payment" => __MODULE__.Payment,
      "status_transitions" => __MODULE__.StatusTransitions
    }
  end
end