Retrieve an InvoicePayment

Changed on

Retrieves the invoice payment with the given ID.

get/v1/invoice_payments/{invoice_payment}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/invoice_payments/{invoice_payment}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

invoice_paymentstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

amount_paidinteger nullable

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_requestedinteger required

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

createdinteger required

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

currencystring required

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

idstring required

Unique identifier for the object.

is_defaultboolean required

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.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'invoice_payment' required

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

statusstring required

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

Changes

  • ae4d4352c52eRevision changes
    • info

      added to the ////// response property anyOf list for the response status

    • info

      removed from the ////// response property anyOf list for the response status

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status

Some revisions have not been checked yet.