---
title: "List billing groups"
method: GET
path: "/v1/billing-groups"
tags: ["billing-groups"]
---

# List billing groups

`GET /v1/billing-groups`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/billing-groups`
- Auth: HTTP bearer

Returns the workspace's billing groups (who pays for which screens), each with its current count of billable screens.

**Notes.**
- Sorted by name; not paginated. Unlike the single read, list rows have no `createdAt` / `updatedAt`.

## Response `200`

Success.

- object
  - `data` object[], required
    - `id` string, required
    - `name` string, required
    - `financeContactName` string, nullable, required
    - `financeContactEmail` string, nullable, required: Where this group's invoices go.
    - `chargebeeCustomerId` string, nullable, required: The billing customer linked by Brix; null until linked.
    - `chargebeeSubscriptionId` string, nullable, required: The subscription linked by Brix; null until linked.
    - `subscriptionStatus` string, nullable, required
    - `paymentTermsDays` integer, nullable, required: Net payment terms in days; null = the workspace default.
    - `screenCount` integer, required: Screens billed to this group.

## 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)