# Brix Account API

**Canonical:** https://apis.io/apis/brixsignage-com/brixsignage-com-account-api/  
**Provider:** Brix — https://apis.io/providers/brixsignage-com/  
**Base URL:** https://api.brixsignage.com  
**Documentation:** https://brixsignage.com/developers/api/

Brix Account API is one of 69 APIs that [Brix](https://apis.io/providers/brixsignage-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The account API from Brix — 60 operation(s) for account.

## Operations (60 of 71)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/account` | Get account overview |
| POST | `/v1/account/about-you` | Answer the first-sign-in questions |
| GET | `/v1/account/billing-address` | Get billing address |
| PUT | `/v1/account/billing-address` | Set billing address |
| POST | `/v1/account/billing-mode` | Switch billing mode |
| POST | `/v1/account/brix-plan` | Choose a plan |
| PUT | `/v1/account/brix-plan/cadence` | Switch plan cadence |
| GET | `/v1/account/brix-plan/playing` | List screens on the plan |
| PUT | `/v1/account/brix-plan/playing` | Choose which screens play |
| GET | `/v1/account/brix-plan/pool` | Get plan screen counts |
| GET | `/v1/account/brix-plan/quote` | Quote a plan |
| PUT | `/v1/account/brix-plan/screens` | Change plan screens |
| POST | `/v1/account/brix-plan/screens/estimate` | Price a screen change |
| POST | `/v1/account/brix-plan/screens/request` | Request more screens |
| DELETE | `/v1/account/brix-plan/trial-plan` | Remove the plan for the trial's end |
| PUT | `/v1/account/brix-plan/trial-plan` | Set the plan for the trial's end |
| POST | `/v1/account/cancel` | Cancel subscription |
| POST | `/v1/account/cancel-deletion` | Cancel pending account deletion |
| GET | `/v1/account/content-scope` | The workspace default content scope (all \| shared): what people see when… |
| PUT | `/v1/account/content-scope` | Set the workspace default content scope ({ contentScope: all \| shared }) |
| PATCH | `/v1/account/contract/renewal` | Set contract auto-renewal |
| GET | `/v1/account/data-inventory` | Get data inventory |
| POST | `/v1/account/downgrade-monthly` | Switch to monthly billing |
| DELETE | `/v1/account/encryption-key` | Disable customer-managed key |
| GET | `/v1/account/encryption-key` | Get encryption key status |
| PUT | `/v1/account/encryption-key` | Enable customer-managed key |
| POST | `/v1/account/encryption-key/verify` | Verify encryption key |
| GET | `/v1/account/export` | Download full data export |
| GET | `/v1/account/export/manifest` | Get export manifest |
| GET | `/v1/account/export/part/{part}` | Download one export part |
| PATCH | `/v1/account/invoice-email` | Set invoice email |
| GET | `/v1/account/invoices` | List invoices |
| GET | `/v1/account/invoices/{id}/file` | Download invoice file |
| POST | `/v1/account/invoices/{id}/pay-link` | Create invoice pay link |
| GET | `/v1/account/invoices/{id}/pdf` | Get invoice PDF link |
| POST | `/v1/account/invoices/pay-all-link` | Create pay-all link |
| POST | `/v1/account/invoices/pay-links-outstanding` | Create links for outstanding invoices |
| GET | `/v1/account/limits` | Get API limits |
| GET | `/v1/account/location-payment` | Get who pays for new locations |
| PUT | `/v1/account/location-payment` | Set whether new locations pay for themselves |
| GET | `/v1/account/me-prefs` | Get my preferences |
| GET | `/v1/account/onboarding` | Get welcome details |
| POST | `/v1/account/onboarding` | Complete onboarding |
| GET | `/v1/account/payers` | List payers |
| POST | `/v1/account/payers` | Add a payer |
| DELETE | `/v1/account/payers/{id}` | Remove a payer |
| PATCH | `/v1/account/payers/{id}` | Edit a payer |
| POST | `/v1/account/payers/{id}/card-link` | Get a payer's card link |
| POST | `/v1/account/payers/resolve` | Preview a payer change |
| GET | `/v1/account/payers/search` | Search payer targets |
| DELETE | `/v1/account/payment-card` | Remove saved card |
| POST | `/v1/account/payment-card/complete` | Complete card setup |
| POST | `/v1/account/payment-card/setup` | Start card setup |
| POST | `/v1/account/payment-card/swap` | Swap card and backup card |
| GET | `/v1/account/payment-methods` | List payment methods |
| POST | `/v1/account/payment-methods/{id}/role` | Set payment method role |
| POST | `/v1/account/payment-methods/manage-url` | Get payment methods management link |
| PATCH | `/v1/account/payment-option` | Set payment option |
| PATCH | `/v1/account/prefs` | Update workspace preferences |
| GET | `/v1/account/provider` | Get the workspace provider |

…and 11 more operations. They are listed in full on the page.

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/brixsignage-com/openapi/brixsignage-com-account-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-screen-schema.json
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-media-asset-detail-schema.json
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-media-asset-schema.json
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-manifest-preview-schema.json
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-media-asset-updated-schema.json
- **JSONSchema** — https://artifacts.apis.io/brixsignage-com/json-schema/brixsignage-com-workspace-prefs-schema.json
- **APIsJSON** — https://artifacts.apis.io/brixsignage-com/apis.yml

## Other Brix APIs (12)

- [Brix Ad Slots API](https://apis.io/apis/brixsignage-com/brixsignage-com-ad-slots-api/)
- [Brix AI API](https://apis.io/apis/brixsignage-com/brixsignage-com-ai-api/)
- [Brix Alert Channels API](https://apis.io/apis/brixsignage-com/brixsignage-com-alert-channels-api/)
- [Brix Alert Events API](https://apis.io/apis/brixsignage-com/brixsignage-com-alert-events-api/)
- [Brix Alert Rules API](https://apis.io/apis/brixsignage-com/brixsignage-com-alert-rules-api/)
- [Brix Alerts API](https://apis.io/apis/brixsignage-com/brixsignage-com-alerts-api/)
- [Brix API Keys API](https://apis.io/apis/brixsignage-com/brixsignage-com-api-keys-api/)
- [Brix App Instances API](https://apis.io/apis/brixsignage-com/brixsignage-com-app-instances-api/)
- [Brix Approvals API](https://apis.io/apis/brixsignage-com/brixsignage-com-approvals-api/)
- [Brix Apps API](https://apis.io/apis/brixsignage-com/brixsignage-com-apps-api/)
- [Brix Audit API](https://apis.io/apis/brixsignage-com/brixsignage-com-audit-api/)
- [Brix Banners API](https://apis.io/apis/brixsignage-com/brixsignage-com-banners-api/)

## Tags

Account

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/brixsignage-com/brixsignage-com-account-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/brixsignage-com/.
