Mayson Monorepo Documentation
    Preparing search index...

    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.

    interface InvoicePayment {
        id: string;
        object: "invoice_payment";
        amount_paid: number;
        amount_requested: number;
        created: number;
        currency: string;
        invoice: string | Stripe.Invoice | DeletedInvoice;
        is_default: boolean;
        livemode: boolean;
        payment: Stripe.InvoicePayment.Payment;
        status: string;
        status_transitions: Stripe.InvoicePayment.StatusTransitions;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "invoice_payment"

    String representing the object's type. Objects of the same type share the same value.

    amount_paid: number

    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.

    amount_requested: number

    Amount intended to be paid toward this invoice, in cents (or local equivalent)

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    currency: string

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    invoice: string | Stripe.Invoice | DeletedInvoice

    The invoice that was paid.

    is_default: boolean

    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: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    status: string

    The status of the payment, one of open, paid, or canceled.