---
title: "Buy screen licences"
method: POST
path: "/v1/account/screen-pool"
tags: ["account"]
---

# Buy screen licences

`POST /v1/account/screen-pool`

## Request

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

Sets how many screens the workspace pays for. An increase is charged now, prorated, to the payment method on file (a very small amount is added to the renewal instead). A reduction on a paid plan takes effect at the renewal and is not refunded; during the free trial a change takes effect at once. You cannot set the plan below the number of screens that are running.

**Notes.**
- An increase is charged now (prorated). A reduction on a paid plan is queued for the renewal and answers `scheduled: true`; in the trial it changes at once.

## Request body

- object
  - `quantity` integer, required

## Response `200`

Success.

- object
  - `data` union, required
    - object
      - `quantity` integer, required: Screens billed now (unchanged until the renewal).
      - `previousQuantity` integer, required
      - `invoiceId` unknown, required
      - `amountPaid` unknown, required
      - `banked` false, required
      - `scheduled` true, required: A reduction on a paid plan, queued for the renewal.
      - `scheduledQuantity` integer, required
      - `effectiveAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - object
      - `quantity` integer, required
      - `previousQuantity` integer, required
      - `invoiceId` string, nullable, required
      - `amountPaid` number, nullable, required
      - `banked` boolean, required: The part-period charge was too small to charge today; it is added to the renewal.
      - `invoiced` boolean, required: An invoice-billed account: an invoice was raised, not charged.
      - `trial` boolean, required: In the free trial: nothing was invoiced.
      - `amountDue` number, nullable, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `402`: `card_declined` or `payment_incomplete`: the plan did not change (or needs our team).
- `403`: You do not hold the permission for the whole workspace (a grant at one location is not enough).
- `409`: `screens_in_use` (below the screens running), `no_subscription`, `account_cancelled`, or `under_contract`.
- `422`: `quantity` is not a whole number from 1 to 10000.
- `502`: The change could not be made.
- `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)