Invoice Payments
Invoice Payments represent payments made against invoices. Invoice Payments can be accessed in two ways:
- By expanding the payments field on the Invoice resource.
- 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.
Was this section helpful? Yes No
Retrieve an InvoicePayment
GET / v1 / invoice_payments /:id
List all payments for an invoice
GET / v1 / invoice_payments
The Invoice Payment object
Attributes
- id string Unique identifier for the object.
- amount _ paid nullable integer Amount that was actually paid for this invoice, in the smallest currency unit. This field is null until the payment is
paid. This amount can be less than theamount_requestedif the PaymentIntent’samount_receivedis not sufficient to pay all of the invoices that it is attached to. - amount _ requested integer Amount intended to be paid toward this invoice, in the smallest currency unit
- invoice string Expandable 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. - payment object The details on the payment.
- status string The status of the payment, one of
open,paid, orcanceled.
More attributes
- object string, value is "invoice_payment"
- created timestamp
- currency string
- livemode boolean
- status _ transitions object
The Invoice Payment object
{ "id": "inpay_1M3USa2eZvKYlo2CBjuwbq0N", "object": "invoice_payment", "amount_paid": 2000, "amount_requested": 2000, "created": 1391288554, "currency": "usd", "invoice": "in_103Q0w2eZvKYlo2C5PYwf6Wf", "is_default": true, "livemode": false, "payment": { "type": "payment_intent", "payment_intent": "pi_103Q0w2eZvKYlo2C364X582Z" }, "status": "paid", "status_transitions": { "canceled_at": null, "paid_at": 1391288554 }}
Retrieve an InvoicePayment
GET / v1 / invoice_payments /:id
Retrieves the invoice payment with the given ID.
Parameters
No parameters.
Returns
Returns an invoice_payment object if a valid invoice payment ID was provided. Otherwise, this call raises an error.
Response
{ "id": "inpay_1M3USa2eZvKYlo2CBjuwbq0N", "object": "invoice_payment", "amount_paid": 2000, "amount_requested": 2000, "created": 1391288554, "currency": "usd", "invoice": "in_103Q0w2eZvKYlo2C5PYwf6Wf", "is_default": true, "livemode": false, "payment": { "type": "payment_intent", "payment_intent": "pi_103Q0w2eZvKYlo2C364X582Z" }, "status": "paid", "status_transitions": { "canceled_at": null, "paid_at": 1391288554 }}