SLslashfi

List invoice series

Changed on

List recurring invoice series.

get/v2/invoices/series

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/invoices/series
  • Auth
    API key in header X-API-Key

Query parameters

cursorstring

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limitinteger

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

sort'createdAt' | 'startDate' | 'nextInvoiceDate'

Field to order the page by. Each value has its own default direction, used unless sortDirection is passed. See Sorting.

  • createdAt (default) — descending
  • startDate — descending
  • nextInvoiceDate — descending
sortDirection'asc' | 'desc'

Direction of the ordering selected by sort. When omitted, each sort value uses its own default; see Sorting.

statusstring[]

Return only series in these statuses.

customerIdstring

Return only series for one customer.

Response

A page of series.

Example response

{
  "items": [
    {
      "id": "inv_series_2rj4l7hmrrrcv",
      "timezone": "America/New_York",
      "lineItems": [
        {
          "name": "Robot arm maintenance",
          "quantity": 2
        }
      ],
      "discount": {
        "percent": 10
      }
    }
  ]
}

Changes