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 valuescanceled
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
- 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.
A Billing Intent represents a request to create, modify or cancel subscriptions.
A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.