Invoices
Get Invoice
This endpoint allows for the retrieval of an invoice by id. It also returns, if available, a pix
and bank_slip
URL for each invoice, which expires after 15 minutes.
GET
/
v1
/
invoices
/
{id}
Path Parameters
The invoice id.
Response
200 - application/json
The request was successfully processed and the invoice is returned.
The unique identifier of the invoice.
The human-readable identifier of the invoice.
The customer associated with this invoice.
The payment account used for this invoice.
The start date of the billing period.
The end date of the billing period.
The total amount to be paid for this invoice.
Required range:
x > 0
List of payments associated with this invoice.
The current status of the invoice.
Available options:
open
, closed
, paid
, canceled
List of plans associated with this invoice.
List of additional items charged in this invoice.
The reason why the billing cycle was closed.
Available options:
end_of_cycle
, billing_end_day_updated