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

# List invoices

`GET /v1/account/invoices`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/account/invoices`
- Auth: HTTP bearer

Returns the workspace's invoice history, newest first: invoices Brix issued for an agreed term and invoices of the card subscription. The response includes `configured: false` when billing has not been set up yet.

## Response `200`

Success.

- object
  - `data` object, required
    - `configured` boolean, required
    - `invoices` union[], required: Newest first. Amounts are in currency units, not cents.
      - union
        - object
          - `source` 'brix', required: An invoice Brix issued (an agreed term).
          - `id` string, required
          - `number` string, required
          - `date` string, required: ISO-8601 timestamp (UTC).
          - `total` number, required
          - `amountDue` number, required
          - `currencyCode` string, required
          - `status` string, required: `payment_due`, `paid`, `voided`, …
          - `paidWith` string, nullable, required: How the invoice is paid: the card it was paid with (`Mastercard •••• 0301`); while open, the account card it will be charged to, or `By invoice`. Null for a payer's unpaid invoice.
          - `poNumber` string, nullable, required
          - `dueDate` string, nullable, required: ISO-8601 timestamp (UTC).
          - `payerName` string, nullable, required: The payer (a franchise or site that pays for its own screens) this invoice bills; null for the account's own.
        - object
          - `source` 'chargebee', required: An invoice of the card subscription.
          - `id` string, required
          - `number` string, required
          - `date` string, nullable, required: ISO-8601 timestamp (UTC).
          - `total` number, required
          - `amountDue` number, required
          - `currencyCode` string, required
          - `status` string, required
          - `paidWith` string, nullable: `Visa •••• 4242`; null when unpaid or not paid by card.
          - `txnIds` string[]: Payment transaction ids.
          - `subscriptionId` string, nullable
    - `reason` string: Present when the card subscription's invoices could not be read.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold the permission for the whole workspace (a grant at one location is not enough).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)