Retrieve Invoices

Facades: merchant

Overview

An aged list of invoices can be retrieved using method parameters that map to URL parameters on the API.

Parameters

ParameterDescription
date_start *The first date for the query filter
date_end *The last date for the query filter
statusThe invoice status you want to query on
order_idThe optional order id specified at time of invoice creation
limitMaximum results that the query will return (useful for paging results)
offsetNumber of results to offset

Example

📘

Note

In this example, we assume that a Client has already been initialized and assigned to the bitpay variable.

invoices = bitpay.get_invoices('2023-04-14', '2023-04-17')