---
title: "Cancel subscription"
method: POST
path: "/v1/account/cancel"
tags: ["account"]
---

# Cancel subscription

`POST /v1/account/cancel`

## Request

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

Submits a cancellation request with a reason. Choosing the reason "Seasonal Business" together with a `restartDate` pauses the account instead of cancelling it. Any other reason schedules cancellation for a fixed number of days after the request. Cancellation can be reversed at any time before it takes effect by calling the reactivate operation.

## Request body

- object
  - `reason` string, required: Survey answer. `Seasonal Business` pauses the account instead of cancelling it.
  - `restartDate` string: Required for `Seasonal Business`: when the account comes back (future, at most 12 months).
  - `competitor` string
  - `returnLikelihood` number
  - `comment` string

## Response `200`

Success.

- object
  - `data` union, required
    - object
      - `status` 'cancel_scheduled', required
      - `cancelEffectiveAt` string, required: 30 days from now.
    - object
      - `status` 'paused', required
      - `pauseUntil` string, required: ISO-8601 timestamp (UTC).

## 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).
- `404`: No such workspace.
- `409`: `payment_required` (unpaid invoice), `already_cancelled`, `under_contract` (an agreed term; contact Brix), or `location_plans_active` (a seasonal pause while a location has its own plan; contact Brix). A cancel schedules each location's own plan to end on the same date.
- `422`: `reason` missing, or a bad `restartDate`.
- `502`: The billing provider did not answer; nothing changed.
- `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)