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 theamount_if the PaymentIntent’srequested amount_is not sufficient to pay all of the invoices that it is attached to.received - 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_. The PaymentIntent associated with the default payment can’t be edited or canceled directly.remaining - paymentobject
The details on the payment.
- statusstring
The status of the payment, one of
open,paid, orcanceled.
More attributes
- objectstring
- createdtimestamp
- currencystring
- livemodeboolean
- status_
transitionsobject
{ "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 }}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.
{ "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 }}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
- invoicestring
The identifier of the invoice whose payments to return.
- paymentobject
The payment details of the invoice payments to return.
- statusenum
The status of the invoice payments to return.
Possible enum valuescanceledThe payment has been canceled; it will not be credited to the invoice.
openThe payment is incomplete and isn’t credited to the invoice. More fine-grained information available on the payment intent
paidThe payment is complete and has been credited to the invoice.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data property that contains an array of up to limit invoice payments, starting after invoice payment starting_. Each entry in the array is a separate invoice_payment object. If no more invoice payments are available, the resulting array will be empty.
{ "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 } } ]}Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates can be created from within the Dashboard, and they can be used over the API when creating invoices.
A Billing Profile is a representation of how a bill is paid, separating payment behavior from customer identity.