Invoices
Invoices and statements are generated weekly and include a summary of all transactions between the invoice's start_date
and end_date
. Users can export an itemized list of all transactions for a billing period in their account.
Actions
GET /invoices |
Retrieves a paginated list of invoices |
GET /invoices/{id} |
Retrieves an invoice or PDF |
Properties
created |
|
currency |
|
end_date |
|
id |
|
name |
|
start_date |
|
total |
|
GET
/invoices
Retrieves a list of invoices
limit |
The number of results to return. Max: 100. Default: 50. |
order |
The order of the results. Can be "asc" for ascending, or "desc" for descending. Default: desc. |
page_token |
Used for selecting the page after the initial query. |
request
GET /invoices
limit=50&order=desc
response
HTTP/1.1 200 OK
{ "invoices": [{ "created": "2021-09-03 13:57:13", "currency": "USD", "end_date": "2021-08-29", "id": 123790, "name": "2021-W34", "start_date": "2021-08-23", "total": 450.86 }, { "created": "2021-09-03 13:57:13", "currency": "CAD", "end_date": "2021-08-29", "id": 123789, "name": "2021-W34", "start_date": "2021-08-23", "total": 770.52 }], "next_page": "ZGF0ZV9lbmQ9MjAyMy0wNy0yOCZsaW1pdD01MCZvcmRlcj1kZXNjJnBhZ2U9MSZsYXN0X2lkPTE1Mzg0Nw==" }
GET
/invoices/{id}
Retrieves an invoice or download the PDF if
type=PDF
. Invoices before 2021-10-31 will not have a PDF.
type |
"PDF" is the only option. |
request
GET /invoices/123790
response
HTTP/1.1 200 OK
{ "created": "2021-09-03 13:57:13", "currency": "USD", "end_date": "2021-08-29", "id": 123790, "name": "2021-W34", "start_date": "2021-08-23", "total": 450.86 }
request
GET /invoices/123790
type=pdf
response
HTTP/1.1 200 OK
[blob]