---
title: "Estimate annual upgrade cost"
method: GET
path: "/v1/account/upgrade-annual/estimate"
tags: ["account"]
---

# Estimate annual upgrade cost

`GET /v1/account/upgrade-annual/estimate`

## Request

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

Returns the prorated cost of switching from monthly to annual billing before committing to it, including which card would be charged.

## Response `200`

Success.

- object
  - `data` object, required
    - `lines` object[], required: Line items of the invoice raised today.
      - `description` string, required
      - `amount` number, required
    - `creditsApplied` number, required: Credit for the unused part of the current term.
    - `subTotal` number, required
    - `amountDueNow` number, required: Charged now, after credits (currency units, not cents).
    - `currencyCode` string, required
    - `nextBillingAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `payWith` string, nullable, required: The payment method that is charged (`Visa •••• 4242`).

## 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).
- `409`: `no_subscription` or `under_contract`.
- `502`: `estimate_unavailable`.
- `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)