--- title: "Get account overview" method: GET path: "/v1/account" tags: ["account"] --- # Get account overview `GET /v1/account` ## Request - Base URL: `https://api.brixsignage.com` - URL: `https://api.brixsignage.com/v1/account` - Auth: HTTP bearer Returns the workspace plan, subscription status, screen pool size, trial or paid status, and onboarding progress. **Notes.** - `email`, `emailVerifiedAt` and `verificationEmailLastSentAt` describe the CALLING user; they are null for an API key. - On a workspace created before the onboarding step existed, a null `prefs.onboardingCompletedAt` is filled with the workspace's creation time (and saved). ## Response `200` Success. - object - `data` Account, required - `scheduledScreenPool` object, nullable, required: A screen plan reduction queued for the renewal. - `quantity` integer, required - `effectiveAt` string, nullable, required: ISO-8601 timestamp (UTC). - `contract` BillingTerm, required: An agreed billing term (a fixed number of screens at a fixed rate for a fixed period). - `id` string, required - `status` 'active' | 'cancelled' | 'awaiting_payment' | 'ended', required - `rail` 'chargebee' | 'brix', required: Who invoices the term: `brix` (Brix invoices) or `chargebee` (the card subscription). - `activateOn` 'now' | 'paid', required - `poNumber` string, nullable, required - `invoiceNumber` string, nullable, required - `invoicePaid` boolean, nullable, required - `activatedAt` string, nullable, required: ISO-8601 timestamp (UTC). - `screens` integer, required - `rateCentsPerScreenMonth` integer, required - `termMonths` integer, required - `schedule` 'upfront' | 'monthly' | 'annual', required - `collect` 'card' | 'invoice', required - `currency` string, required - `startsAt` string, required: Date (YYYY-MM-DD). - `endsAt` string, required: Date (YYYY-MM-DD). - `totalCents` integer, required - `monthlyCents` integer, required - `termLabel` string, required - `scheduleLabel` string, required - `invoiceId` string, nullable, required - `notes` string, nullable, required - `createdBy` string, nullable, required - `prior` object, nullable, required: The plan before the term started. - `quantity` integer, required - `unitPriceCents` integer, nullable, required - `createdAt` string, required: ISO-8601 timestamp (UTC). - `endedAt` string, nullable, required: ISO-8601 timestamp (UTC). - `renewal` 'renew' | 'non_renewing', required - `renewalInvoiceId` string, nullable, required - `origin` 'staff' | 'self_serve', required: `self_serve` — the customer chose this plan on the Billing page; `staff` — an agreed term set by Brix. - `next` object, nullable, required: What the next period starts with, when the customer asked for a change at renewal. - `screens` integer, nullable, required - `termMonths` integer, nullable, required - `rateCentsPerScreenMonth` integer, nullable, required - `id` string, required: Workspace id (the account id support asks for). - `whiteLabel` boolean, required: A partner bills this workspace; Brix billing does not apply. - `status` 'active' | 'cancel_scheduled' | 'paused' | 'past_due' | 'suspended' | 'cancelled', required - `pauseUntil` string, nullable, required: ISO-8601 timestamp (UTC). - `cancelEffectiveAt` string, nullable, required: ISO-8601 timestamp (UTC). - `cancelReason` 'provider' | 'trial_expired' | 'voluntary' | 'nonpayment', nullable, required - `everPaid` boolean, required - `deletionRequestedAt` string, nullable, required: ISO-8601 timestamp (UTC). - `billingBanner` BillingBanner, required - `severity` 'warning' | 'critical', required - `status` 'past_due' | 'suspended' | 'trial_expired' | 'awaiting_payment' | 'invoice_dunning', required - `headline` string, required - `body` string, required - `payBy` string, nullable, required: ISO-8601 timestamp (UTC). - `action` object, required - `label` string, required - `kind` 'pay', required - `survey` unknown, required - `prefs` WorkspacePrefs, required: Workspace preferences. Every key is present (defaults filled in). - `timeFormat` '12h' | '24h', required - `weekStart` 'mon' | 'sun', required - `dateFormat` 'mdy' | 'dmy' | 'ymd', required - `tempUnits` 'f' | 'c', required - `timeZone` string, required: IANA time zone. Screens without their own zone use it, and so do schedules timed by the workspace. - `language` string, required: BCP 47 language tag. - `multinational` boolean, required: Shows the per-location and per-screen language settings. - `newLocationsPayFirst` boolean, required: New locations pay for themselves before going live: each adds its own card, and its screens show a hold card (not billed to the account) until then. Default false. Turning it on needs Brix billing with a running plan (409 otherwise). - `navExtras` string[], required: Console pages switched on that the workspace size hides by default. - `appBranding` object, required: The look of the on-screen apps. - `accent` string, required - `accent2` string, required - `theme` 'dark' | 'light', required - `backdrop` 'brand' | 'wash' | 'plain' | 'aurora' | 'dots' | 'grid' | 'solid', required - `intensity` number, required - `audio` object, required: Default screen volume and a master mute. - `volume` number, required: 0–100. - `muted` boolean, required - `brand` object, required - `companyName` string, required - `logoUrl` string, required - `requireAltText` boolean, required - `showScreenLogo` boolean, required - `keepTvOnInput` boolean, required: Default for "Keep the TV on this input" on screens that have not set their own. - `standbyContentKind` string, nullable, required: What a screen with nothing to play shows; null = the default card. - `standbyContentId` string, nullable, required - `tier` 'simple' | 'team' | 'enterprise', required: Workspace size. It sets console defaults, not access. - `industry` string, nullable, required - `onboardingCompletedAt` string, nullable, required: ISO-8601 timestamp (UTC). - `setupStep` string, nullable, required: Walkthrough position (`s1`…`s5`, `l1`…`l6`, `done`). - `welcomeDeclinedAt` string, nullable, required: ISO-8601 timestamp (UTC). - `aboutYouDue` boolean: The workspace is asked the first-sign-in questions (workspaces created from 2026-10-14). - `aboutYouAt` string, nullable: ISO-8601 timestamp (UTC). - `expectedScreens` integer, nullable: How many screens the owner said they expect. - `orgNameSet` boolean, required - `tiers` integer[], required: Location tree levels in use. - `tierLabels` object, required: Custom names for the location tree levels. - `requireTwoFactor` boolean, required - `requireSso` boolean, required - `requireSsoPending` boolean, required: Single sign-on was required, and turns on after the first sign-in through the connection. - `requireSsoPendingSince` string, nullable, required: ISO-8601 timestamp (UTC). - `ai` object, required - `enabled` boolean, required - `features` object, required: Per feature (`tags`, `alt-text`, `moderation`, `transcription`, `translation`, `focal-region`, `embedding`); an absent feature follows `enabled`. - `dailyCallLimit` integer, nullable, required - `redactPersonalData` boolean, required - `retention` object, required: Days kept per stream, only for the streams the workspace has set. An absent stream uses the platform window. - `offline` number - `screenshots` number - `playback` number - `deviceLogs` number - `vitals` number - `replays` number - `aiEvents` number - `warehouse` object, required: Data warehouse feed. Set by Brix; not writable here. - `enabled` boolean, required - `bucketBinding` string, required: Set by Brix when the data warehouse feed is provisioned. - `tables` string[], required - `lookbackDays` integer, required - `supportAccess` SupportAccessPolicy, required - `mode` 'open' | 'notify' | 'approve', required: `open`: Brix support may open the workspace. `notify`: it may, and the owners are emailed. `approve`: a person here must approve each request. - `grantMinutes` integer, required: How long an approval lasts. - `requestTtlMinutes` integer, required: How long a request waits for an answer before it expires. - `kioskHasGlobalPin` boolean, required: A workspace Screen Lock PIN is set. The PIN and its hash are never returned. - `region` 'us' | 'eu' | 'oc' | 'apac', required: Where the workspace's data is stored. - `dbRegion` 'us' | 'eu' | 'oc' | 'apac', required: Where the workspace's records are stored. Can differ from `region` for workspaces created before regional sign-up: media in the region, records on the primary. - `billingProvider` 'chargebee' | 'brix', required: `brix`: Brix invoices the account (see `payment`). `chargebee`: a card subscription. - `payment` AccountPayment, required: Payment settings of an account that Brix invoices directly. - `option` 'card' | 'invoice', required: How issued invoices are paid: charged to the saved card, or paid from the invoice email. - `card` object, nullable, required - `brand` string, required - `last4` string, nullable, required - `expMonth` integer, nullable, required - `expYear` integer, nullable, required - `savedAt` string, nullable, required: ISO-8601 timestamp (UTC). - `backupCard` object, nullable, required: Charged once when the card is declined. - `brand` string, required - `last4` string, nullable, required - `expMonth` integer, nullable, required - `expYear` integer, nullable, required - `savedAt` string, nullable, required: ISO-8601 timestamp (UTC). - `lastPaid` object, nullable, required: The card the last invoice was paid with. - `label` string, required: `Visa •••• 5278`. - `brand` string, required - `last4` string, required - `invoiceNumber` string, required - `paidAt` string, nullable, required: ISO-8601 timestamp (UTC). - `cardAvailable` boolean, required: Card payment can be set up for this workspace. - `invoiceEmail` string, nullable, required: One more address that gets every invoice. The owners always get them. - `subscriptionStatus` string, nullable, required - `cadence` 'monthly' | 'annual', nullable, required - `billableScreens` integer, required: Screens that count toward the bill now. - `licensedScreens` integer, nullable, required: Screens bought (the plan quantity or the term's screens). - `trialEndsAt` string, nullable, required: ISO-8601 timestamp (UTC). - `nextBillingAt` string, nullable, required: ISO-8601 timestamp (UTC). - `currentTermEndsAt` string, nullable, required: ISO-8601 timestamp (UTC). - `emailVerifiedAt` string, nullable, required: ISO-8601 timestamp (UTC). - `verificationEmailLastSentAt` string, nullable, required: ISO-8601 timestamp (UTC). - `email` string, nullable, required: The calling user's email; null for an API key. ## 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)