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

# List invoices

`GET /invoices`

## Request

- Base URL: `https://api.crevio.co/v1`
- URL: `https://api.crevio.co/v1/invoices`
- Auth: API key in header `Authorization`

Returns a list of invoices for the current account

## Query parameters

- `status` 'open' | 'paid' | 'past_due' | 'void'
- `customer` string
- `expand` string
- `starting_after` string
- `limit` integer

## Response `200`

List of invoices

- ListResponseInvoice
  - `object` 'list', required
  - `data` Invoice[], required
    - `id` string, required
    - `object` string, required
    - `status` 'open' | 'paid' | 'past_due' | 'void', required
    - `number` string, required
    - `description` string, nullable, required
    - `customer_name` string, nullable, required
    - `email_address` string, nullable, required
    - `collection_method` 'send_invoice' | 'charge_automatically', required
    - `due_at` string, date-time, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `checkout_url` string, nullable, required
    - `amount` number, nullable, required
    - `currency` string, nullable, required
    - `paid_at` string, nullable, required
    - `customer` union: ID by default, full object when expanded
      - string
      - Customer
        - `id` string, required
        - `object` string, required
        - `email` string, required
        - `name` string, nullable, required
        - `first_name` string, nullable, required
        - `last_name` string, nullable, required
        - `phone_number` string, nullable, required
        - `customer_type` 'paid' | 'free' | 'lead', required
        - `notes` string, nullable, required
        - `confirmed_at` string, date-time, nullable, required
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
        - `deleted_at` string, date-time, nullable, required
        - `purge_at` string, nullable, required
        - `anonymized` boolean, required
        - `metadata` object, required
        - `orders_count` integer, required
        - `total_spend` number, required
        - `tags` unknown[], required
          - unknown
    - `price_variant` union, required: ID by default, full object when expanded
      - string
      - PriceVariant
        - `id` string, required
        - `object` string, required
        - `name` string, required
        - `amount` integer, nullable, required
        - `amount_type` 'free' | 'fixed' | 'custom', required
        - `billing_type` 'subscription' | 'one_time' | 'payment_plan', required
        - `recurring_interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable, required
        - `interval_count` integer, required
        - `installment_count` integer, nullable, required
        - `setup_fee_amount` integer, nullable, required
        - `trial_period_days` integer, nullable, required
        - `revoke_after_days` integer, nullable, required
        - `quantity_available` integer, nullable, required
        - `archived` boolean, nullable, required
        - `position` integer, required
        - `hidden` boolean, nullable, required
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
        - `currency` string, nullable, required
        - `discounted_from_amount` integer, nullable, required
        - `minimum_amount` integer, nullable, required
        - `maximum_amount` integer, nullable, required
        - `preset_amount` integer, nullable, required
        - `waitlist` boolean, required
        - `benefits` string[]
        - `purchase_url` string, required
        - `product` string, required
    - `order` union: ID by default, full object when expanded
      - string
      - Order
        - `id` string, required
        - `object` string, required
        - `status` 'succeeded' | 'pending' | 'failed' | 'refunded' | 'partially_refunded' | 'disputed', required
        - `livemode` boolean, required
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
        - `metadata` object, nullable, required
        - `amount` integer, required: Amount charged after discounts, in the smallest currency unit (79 = $0.79).
        - `currency` string, required
        - `amount_refunded` integer, required: Amount refunded so far, in the smallest currency unit.
        - `customer` union, required: ID by default, full object when expanded
          - string
          - Customer
            - `id` string, required
            - `object` string, required
            - `email` string, required
            - `name` string, nullable, required
            - `first_name` string, nullable, required
            - `last_name` string, nullable, required
            - `phone_number` string, nullable, required
            - `customer_type` 'paid' | 'free' | 'lead', required
            - `notes` string, nullable, required
            - `confirmed_at` string, date-time, nullable, required
            - `created_at` string, date-time, required
            - `updated_at` string, date-time, required
            - `deleted_at` string, date-time, nullable, required
            - `purge_at` string, nullable, required
            - `anonymized` boolean, required
            - `metadata` object, required
            - `orders_count` integer, required
            - `total_spend` number, required
            - `tags` unknown[], required
              - …
        - `line_items` OrderItem[]
          - `id` string, required
          - `object` string, required
          - `quantity` integer, required
          - `order` union: ID by default, full object when expanded
            - string
            - Order (recursive)
          - `price_variant` union, required: ID by default, full object when expanded
            - string
            - PriceVariant
              - …
          - `product` union, required: ID by default, full object when expanded
            - string
            - Product
              - …
        - `checkout` string, required
        - `billing_address` Address, required
          - `name` string, nullable, required
          - `line1` string, nullable, required
          - `line2` string, nullable, required
          - `city` string, nullable, required
          - `state` string, nullable, required
          - `postal_code` string, nullable, required
          - `country` string, nullable, required
        - `shipping_address` Address, required
          - `name` string, nullable, required
          - `line1` string, nullable, required
          - `line2` string, nullable, required
          - `city` string, nullable, required
          - `state` string, nullable, required
          - `postal_code` string, nullable, required
          - `country` string, nullable, required
        - `charge` string, nullable, required
  - `has_more` boolean, required
  - `url` string, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Forbidden
- `429`: Rate limit exceeded — 600 requests per minute per credential. Retry after the number of seconds in `Retry-After`.
- `500`: Internal server error

---

[API](https://skmtc.dev/crevio/apis/crevio-api-v1.md) · [All operations](https://skmtc.dev/crevio/apis/crevio-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/crevio/apis/crevio-api-v1/revisions/2219f18ad651?raw)