Account API (part 3 of 4)

PUT /v1/account/location-payment

Auth: Bearer token.

Turn on or off the account setting that makes new locations pay for their own screens before they go live. Send { newLocationsPayFirst: true | false }. Requires billing.edit on the whole account; an API key also needs the location-payment.edit scope, and a connected app cannot change it. Returns 409 when the account cannot use location payment. The change is recorded in the activity log.

curl -X PUT "https://api.brixsignage.com/v1/account/location-payment" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

PATCH /v1/account/look-prefs

Auth: Bearer token. Permission: settings.edit.

Updates the brand kit, the organization tiers and the AI settings. Needs permission to edit settings. Any other preference is refused: use the workspace preferences route, which needs permission to edit billing.

curl -X PATCH "https://api.brixsignage.com/v1/account/look-prefs" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"showScreenLogo":true}'

Response 200: Success.

Response 401: Missing, expired or revoked bearer token.

Response 403: You do not hold the permission for the whole workspace (a grant at one location is not enough).

Response 422: A key that this route does not change.

Response 5XX: Server error. The body carries a requestId to quote to support.

GET /v1/account/me-prefs

Auth: Bearer token. Permission: billing.view.

Returns preferences in three layers: workspace (the shared defaults), user (only the values the calling user has changed; empty for an API key), and effective (the merged result to use for display). Notes. - user is returned as saved: the per-user write does not check its keys or values.

curl "https://api.brixsignage.com/v1/account/me-prefs" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200: Success.

Response 401: Missing, expired or revoked bearer token.

Response 403: The token lacks the permission this operation needs (see x-brix-permission).

Response 5XX: Server error. The body carries a requestId to quote to support.

GET /v1/account/onboarding

Auth: Bearer token.

Returns what the welcome panel needs: how the owner signed up (email, Google or Microsoft), the workspace country, whether a phone number is on file, and the region where the workspace data is stored, with a plain place name.

curl "https://api.brixsignage.com/v1/account/onboarding" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

POST /v1/account/onboarding

Auth: Bearer token. Permission: billing.edit.

Finishes workspace onboarding in a single call: renames the workspace to the given name, records the industry and complexity tier, marks onboarding as complete, and seeds a starter set of ready-to-play content tailored to the chosen industry. Combining these into one call ensures the completion flag and the seeded content are never out of sync. Notes. - Every call adds the starter content again; it is not idempotent. - tier is stored as sent without a check.

Request body: application/json

curl -X POST "https://api.brixsignage.com/v1/account/onboarding" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200: Success.

Response 401: Missing, expired or revoked bearer token.

Response 403: You do not hold the permission for the whole workspace (a grant at one location is not enough).

Response 422: Unknown industry.

Response 5XX: Server error. The body carries a requestId to quote to support.

GET /v1/account/payers

Auth: Bearer token.

Lists who pays for the screens. The main account comes first, with the screens it pays for, its price and how often it is billed. Then each payer follows with its status, card, targets (locations, screen groups and screens), screen count and price.

curl "https://api.brixsignage.com/v1/account/payers" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

POST /v1/account/payers

Auth: Bearer token.

Adds a payer, such as a franchise or a site that pays for its own screens. Send its name, finance email and targets. The payer starts to pay for its screens when its first invoice is paid. The change is recorded in the activity log.

curl -X POST "https://api.brixsignage.com/v1/account/payers" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

PATCH /v1/account/payers/{id}

Auth: Bearer token.

Changes a payer's name, finance email, address or targets. New targets change which payer pays for each screen. Screens added during a term are invoiced to the payer now, for the remaining part of the term. The change is recorded in the activity log.

curl -X PATCH "https://api.brixsignage.com/v1/account/payers/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

DELETE /v1/account/payers/{id}

Auth: Bearer token.

Removes a payer. Its screens go back to the main account from the next billing period, and its unpaid invoices stay open. Returns 409 not_brix_billed when the account is not billed by Brix. The change is recorded in the activity log.

curl -X DELETE "https://api.brixsignage.com/v1/account/payers/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

POST /v1/account/payers/{id}/card-link

Auth: Bearer token.

Returns a signed link, valid for 90 days, to a page where the payer's finance team adds a card without signing in. Send send: true to email the link to the payer's finance email.

curl -X POST "https://api.brixsignage.com/v1/account/payers/{id}/card-link" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

POST /v1/account/payers/resolve

Auth: Bearer token.

Shows the result of a payer edit before you save it: the payer's screen count and price, the screens it would take from other payers, and the screens that two screen groups give to different payers. Nothing is saved.

curl -X POST "https://api.brixsignage.com/v1/account/payers/resolve" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

GET /v1/account/payers/search

Auth: Bearer token.

Finds locations, screen groups and screens that match q, for use as payer targets. Each screen shows the payer that pays for it now. Locations are included only when the workspace has more than one. At most 50 results of each kind are returned.

curl "https://api.brixsignage.com/v1/account/payers/search" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 4XX: Client error. 404 rather than 403 for another tenant's resource, so account existence is not leaked.

Response 5XX: Server error. The body carries a requestId to quote to support.

DELETE /v1/account/payment-card

Auth: Bearer token. Permission: billing.edit.

Removes the workspace's saved card. If the payment option was set to card, it reverts to invoice billing. Notes. - Removing the card when a backup card is saved makes the backup the card. With no backup and the payment option card, the option goes back to invoice.

curl -X DELETE "https://api.brixsignage.com/v1/account/payment-card" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200: Success.

Response 401: Missing, expired or revoked bearer token.

Response 403: You do not hold the permission for the whole workspace (a grant at one location is not enough).

Response 404: A workspace billed by a partner.

Response 409: not_brix_billed.

Response 5XX: Server error. The body carries a requestId to quote to support.

POST /v1/account/payment-card/complete

Auth: Bearer token. Permission: billing.edit.

Saves the card from a finished hosted card-setup session, given its sessionId. Brix re-reads the session from the payment provider and confirms it belongs to the calling workspace, returning 404 otherwise. The same result also happens automatically when the payment provider notifies Brix that the session completed.

Request body: application/json

curl -X POST "https://api.brixsignage.com/v1/account/payment-card/complete" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200: Success.

Response 401: Missing, expired or revoked bearer token.

Response 403: You do not hold the permission for the whole workspace (a grant at one location is not enough).

Response 404: Not a card session of this workspace.

Response 409: not_brix_billed.

Response 422: sessionId missing or malformed.

Response 502: The session could not be read.

Response 5XX: Server error. The body carries a requestId to quote to support.