Sample - Stripe API
GET/v1/invoice_payments/{invoice_payment}

Get an invoice payment

Retrieves an invoice payment by its identifier. Use expand to include selected related invoice or payment resources directly in the response.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
invoice_paymentstringrequired
The unique identifier of the invoice payment to retrieve. Maximum 5000 characters.
expandarray<string>optional
Fields to expand in the response. Each value must be no longer than 5000 characters.

2 status codes
200Returns the invoice payment, including requested and paid amounts, currency, invoice, associated payment, status, default-payment flag, and status transition timestamps.
amount_paidintegeroptional
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_requestedintegerrequired
Amount intended to be paid toward this invoice, in cents (or local equivalent)
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
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).
idstringrequired
Unique identifier for the object.
invoicestringrequired
The invoice that was paid.
is_defaultbooleanrequired
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.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:invoice_payment
paymentobjectrequired
statusstringrequired
The status of the payment, one of `open`, `paid`, or `canceled`.
status_transitionsobjectrequired
defaultError response.
errorobjectrequired

Error handling

invoice_payment must identify the invoice payment to retrieve and must be no longer than 5000 characters. Each expand value must also be no longer than 5000 characters.