GET
/
invoices
List invoices
curl --request GET \
  --url https://api.chargeapi.co/v1/invoices \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "object": "list",
  "url": "<string>",
  "has_more": true,
  "data": [
    {
      "id": null,
      "object": null,
      "amount_due": null,
      "amount_paid": null,
      "created": null,
      "currency": null,
      "due_date": null,
      "line_items": null,
      "paid_at": null,
      "period_end": null,
      "period_start": null,
      "status": null
    }
  ]
}

Query Parameters

​
limit
integer

Maximum number of invoices to return (default 10).

Required range: 1 <= x <= 100
​
starting_after
string

Pagination cursor; returns items after this invoice ID.

​
ending_before
string

Pagination cursor; returns items before this invoice ID.

​
status
enum<string>

Filter results by invoice status.

Available options:
draft,
open,
paid,
void,
uncollectible
​
expand
string[]

Specifies related objects to expand in each invoice (for example, expand[]=line_items).

Body

application/json · object

Response

A dictionary with a data property that contains an array of up to limit Invoice objects, starting after Invoice starting_after. Each entry in data is a separate Invoice object. If no additional invoices are available, the array is empty.

The response is of type object.