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 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 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, or canceled.

More attributes

object string, value is "invoice_payment"
created timestamp
currency string
livemode boolean
status _ transitions 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 }}

List all payments for an invoice

GET / v1 / invoice_payments

When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.

Parameters

invoice string The identifier of the invoice whose payments to return.
payment object The payment details of the invoice payments to return.
status enum The status of the invoice payments to return. Possible enum values canceled The payment has been canceled; it will not be credited to the invoice. open The payment is incomplete and isn’t credited to the invoice. More fine-grained information available on the payment intent paid The payment is complete and has been credited to the invoice.

More parameters

created object
ending _ before string
limit integer
starting _ after string

Returns

A dictionary with a data property that contains an array of up to limit invoice payments, starting after invoice payment starting_after. Each entry in the array is a separate invoice_payment object. If no more invoice payments are available, the resulting array will be empty.

Response

{ "object": "list", "url": "/v1/invoice_payments", "has_more": false, "data": [ { "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 } } ]}