The Invoice Payment object 

Attributes

• idstring

  Unique identifier for the object.

• amount_paidnullable integer

  Amount that was actually paid for this invoice, in cents. 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_requestedinteger

  Amount intended to be paid toward this invoice, in cents

• invoicestringExpandable

  The invoice that was paid.

• is_defaultboolean

  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.

• paymentobject

  The details on the payment.

  Hide child attributes

  • payment.chargenullable stringExpandable

    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.payment_intentnullable stringExpandable

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

    Type of payment object associated with this invoice payment.

    Possible enum values

    charge

    payment_intent

• statusstring

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

More attributes

Collapse all

• objectstring

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

• createdtimestamp

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

• currencystring

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

• livemodeboolean

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

• status_transitionsobject

  The timestamps when the payment’s status was updated.

  Hide child attributes

  • status_transitions.canceled_atnullable timestamp

    The time that the payment was canceled.

  • status_transitions.paid_atnullable timestamp

    The time that the payment succeeded.