---
title: "List invoices"
method: GET
path: "/v2/invoices"
tags: ["Invoices"]
---

# List invoices

`GET /v2/invoices`

Retrieve existing invoices. By default, invoices with status open are not included.

## Query parameters

- `limit` number — Maximum number of items to return (1-100).
- `cursor` string — Opaque cursor returned in the previous response's `next_cursor`. Omit to fetch the first page.
- `include_total` union — Set to `true` to include `total` in the response.
  - boolean
  - 'true' | 'false'
- `order` 'asc' | 'desc' — Sort direction.
- `sort` 'created_at' | 'emitted_at' — Field used to sort the results.
- `type` union
  - 'invoice' | 'refund' | 'document' | 'child_invoice_ref' | 'child_creditnote_ref'
  - string — invoice,refund
- `type__in` union
  - 'invoice' | 'refund' | 'document' | 'child_invoice_ref' | 'child_creditnote_ref'
  - string — invoice,refund
- `status` union
  - 'all' | 'open' | 'grace_period' | 'to_pay' | 'to_reconcile' | 'error' | 'paid' | 'partially_paid' | 'outstanding' | 'refunded' | 'late' | 'draft' | 'voided' | 'closed' | 'uncollectible' | 'pending_consolidation' | 'consolidated'
  - string — all,open
- `status__in` union
  - 'all' | 'open' | 'grace_period' | 'to_pay' | 'to_reconcile' | 'error' | 'paid' | 'partially_paid' | 'outstanding' | 'refunded' | 'late' | 'draft' | 'voided' | 'closed' | 'uncollectible' | 'pending_consolidation' | 'consolidated'
  - string — all,open
- `customer_id` string
- `customer_id__not` string
- `customer_id__isNull` string
- `customer_id__isNotNull` string
- `customer_id__equals` string
- `customer_id__contains` string
- `customer_id__startsWith` string
- `customer_id__endWith` string
- `customer_external_id` string
- `subscription_id` string
- `subscription_id__not` string
- `subscription_id__isNull` string
- `subscription_id__isNotNull` string
- `subscription_id__equals` string
- `subscription_id__contains` string
- `subscription_id__startsWith` string
- `subscription_id__endWith` string
- `invoicing_entity_id` string
- `invoicing_entity_id__not` string
- `invoicing_entity_id__isNull` string
- `invoicing_entity_id__isNotNull` string
- `invoicing_entity_id__equals` string
- `invoicing_entity_id__contains` string
- `invoicing_entity_id__startsWith` string
- `invoicing_entity_id__endWith` string
- `invoice_number` string
- `invoice_number__not` string
- `invoice_number__isNull` string
- `invoice_number__isNotNull` string
- `invoice_number__equals` string
- `invoice_number__contains` string
- `invoice_number__startsWith` string
- `invoice_number__endWith` string
- `original_invoice_id` string
- `original_invoice_id__not` string
- `original_invoice_id__isNull` string
- `original_invoice_id__isNotNull` string
- `original_invoice_id__equals` string
- `original_invoice_id__contains` string
- `original_invoice_id__startsWith` string
- `original_invoice_id__endWith` string
- `original_invoice_number` string
- `original_invoice_number__not` string
- `original_invoice_number__isNull` string
- `original_invoice_number__isNotNull` string
- `original_invoice_number__equals` string
- `original_invoice_number__contains` string
- `original_invoice_number__startsWith` string
- `original_invoice_number__endWith` string
- `line_item_id` string
- `period_start` string, date-time
- `period_start__not` string, date-time
- `period_start__isNull` string, date-time
- `period_start__isNotNull` string, date-time
- `period_start__equals` string, date-time
- `period_start__lt` string, date-time
- `period_start__lte` string, date-time
- `period_start__gt` string, date-time
- `period_start__gte` string, date-time
- `period_end` string, date-time
- `period_end__not` string, date-time
- `period_end__isNull` string, date-time
- `period_end__isNotNull` string, date-time
- `period_end__equals` string, date-time
- `period_end__lt` string, date-time
- `period_end__lte` string, date-time
- `period_end__gt` string, date-time
- `period_end__gte` string, date-time
- `issued_at` string, date-time
- `issued_at__not` string, date-time
- `issued_at__isNull` string, date-time
- `issued_at__isNotNull` string, date-time
- `issued_at__equals` string, date-time
- `issued_at__lt` string, date-time
- `issued_at__lte` string, date-time
- `issued_at__gt` string, date-time
- `issued_at__gte` string, date-time
- `due_at` string, date-time
- `due_at__not` string, date-time
- `due_at__isNull` string, date-time
- `due_at__isNotNull` string, date-time
- `due_at__equals` string, date-time
- `due_at__lt` string, date-time
- `due_at__lte` string, date-time
- `due_at__gt` string, date-time
- `due_at__gte` string, date-time
- `updated_at` string, date-time
- `updated_at__not` string, date-time
- `updated_at__isNull` string, date-time
- `updated_at__isNotNull` string, date-time
- `updated_at__equals` string, date-time
- `updated_at__lt` string, date-time
- `updated_at__lte` string, date-time
- `updated_at__gt` string, date-time
- `updated_at__gte` string, date-time

## Response `200`

- CursorPaginatedInvoice — unresolved $ref

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)