---
title: "Get Invoices"
method: GET
path: "/v1/invoices/"
---

# Get Invoices

`GET /v1/invoices/`

## Query parameters

- `limit` integer
- `page` integer
- `created_at[intl]` integer
- `created_at[eq]` string
- `created_at[gte]` string
- `created_at[lte]` string
- `created_at[gt]` string
- `created_at[lt]` string
- `total[eq]` integer
- `total[gte]` integer
- `total[lte]` integer
- `total[gt]` integer
- `total[lt]` integer
- `invoice_number[like]` string
- `draft[eq]` boolean
- `closed[eq]` boolean
- `attempted[eq]` boolean
- `forgiven[eq]` boolean
- `open` boolean
- `past_due` boolean
- `paid` boolean
- `search` string
- `excel` string

## Response `200`

200

- object
  - `data` object[]
    - `object` string
    - `id` string
    - `subscription_name` string
    - `subscription_id` string
    - `quantity` integer
    - `customer_id` string
    - `discount_id` unknown
    - `plan_id` string
    - `plan_amount` integer
    - `amount_paid` integer
    - `amount_due` integer
    - `amount_remaining` integer
    - `subtotal` integer
    - `attempted` integer
    - `billing` integer
    - `invoice_number` string
    - `tax_percent` unknown
    - `tax_amount` integer
    - `receipt_number` string
    - `paid` integer
    - `period_end` integer
    - `period_start` integer
    - `statement_description` string
    - `closed` integer
    - `currency` string
    - `ending_balance` integer
    - `forgiven` integer
    - `closed_at` unknown
    - `discount_amount` integer
    - `draft` unknown
    - `frozen` integer
    - `created_at` integer
    - `updated_at` integer
    - `total` integer
    - `description` unknown
    - `failure_message` unknown
    - `created_by` string
    - `customer` object
      - `data` object
        - `object` string
        - `customer_id` string
        - `name` unknown
        - `email` string
        - `description` unknown
        - `payment_overdue` integer
        - `send_email_address` unknown
        - `cc_email_address` unknown
        - `source_id` string
        - `address_1` unknown
        - `address_2` unknown
        - `city` unknown
        - `state` unknown
        - `zip` unknown
        - `phone` unknown
        - `country` unknown
        - `created_at` integer
        - `updated_at` integer
        - `readable_created_at` string
        - `readable_updated_at` string
        - `invoice_prefix` string
        - `card` object
          - `data` object[]
            - `object` string
            - `id` string
            - `address1` unknown
            - `address2` unknown
            - `card_source` string
            - `card_holder_name` unknown
            - `is_default` integer
            - `exp_month` string
            - `exp_year` string
            - `is_verified` integer
            - `fingerprint` string
            - `city` unknown
            - `state` unknown
            - `zip` unknown
            - `brand` string
            - `last4digit` string
            - `first6digit` integer
            - `country` unknown
            - `avs_status` string
            - `cvc_status` string
            - `address_check_passed` integer
            - `zip_check_passed` integer
            - `customer_id` string
            - `created_at` integer
            - `updated_at` integer
            - `card_type` string
            - `bin_country` string
            - `bank_name` unknown
            - `bank_website` unknown
            - `bank_phone` unknown
        - `bank_account` object
          - `data` unknown[]
            - unknown
    - `charge` object
      - `data` unknown[]
        - unknown
    - `achcharge` object
      - `data` unknown[]
        - unknown
  - `meta` object
    - `include` string[]
    - `custom` unknown[]
      - unknown
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer
      - `links` object

## Other responses

- `401` — 401

---

[API](https://skmtc.net/payarc/apis/payarc-sandbox.md) · [All operations](https://skmtc.net/payarc/apis/payarc-sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payarc/payarc-sandbox/revisions/face82bdd778/schema)