Brix Billing Groups API

openapi: 3.2.0
info:
  title: Brix Billing Groups API
  version: '1'
  summary: 'Control plane for Brix digital signage: screens, content, playlists, schedules, casts and emergencies.'
  description: 'Generated from the route table the API actually mounts

    (`apps/api/routes.snapshot.json`), the description each route is required to

    carry (`tests/contracts/route-registry.json`), and request/response schemas

    (`apps/api/src/openapi/`). CI enforces all three, so this document cannot list a

    route that does not exist or omit one that does.


    **Schemas.** 447 operations carry request and response schemas

    (`x-brix-schema: verified`). Each is checked in CI against the response the

    real handler returns — a missing, mistyped or undeclared field fails the build.

    The remaining operations are route-level only (`x-brix-schema: none`): their

    path, method, permission and purpose are exact, but the shape of `data` is not

    yet modelled, and we would rather say so than publish a schema that validates

    against nothing. Objects are open: a new field is not a breaking change.


    **Envelope.** Success bodies are `{ "data": … }`. Failures are

    `{ "error": "", "message": "…" }`, plus `requestId` on a 5xx.

    Many list routes page opt-in (see each operation): pass `?limit=` and

    follow `nextCursor` via `?cursor=` until it is null.


    **Authentication.** `Authorization: Bearer ` with an API key

    (`ak_…`, created in the console under Settings → API & MCP) or a user session. An

    API key carries a creator-chosen set of `resource.verb` permissions and may be

    pinned to one location''s subtree; a key can never be granted a permission its

    creator does not hold. The permission an operation needs is in

    `x-brix-permission` and in its security requirement.


    **Tenancy.** Every request resolves to one workspace. A resource belonging to

    another tenant returns 404, never 403, so a response never confirms that an

    account exists.


    **Rate limits.** A 429 carries `Retry-After`; a 503 `database_busy` means retry

    after the `Retry-After` interval.'
servers:
- url: https://api.brixsignage.com
  description: Production
security:
- bearerAuth: []
tags:
- name: billing-groups
paths:
  /v1/billing-groups:
    get:
      operationId: listBillingGroups
      tags:
      - billing-groups
      summary: List billing groups
      description: 'Returns the workspace''s billing groups (who pays for which screens), each with its current count of billable screens.


        **Notes.**

        - Sorted by name; not paginated. Unlike the single read, list rows have no `createdAt` / `updatedAt`.'
      x-brix-permission: billing.view
      x-brix-schema: verified
      x-brix-notes:
      - Sorted by name; not paginated. Unlike the single read, list rows have no `createdAt` / `updatedAt`.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        financeContactName:
                          anyOf:
                          - type: string
                          - type: 'null'
                        financeContactEmail:
                          anyOf:
                          - type: string
                          - type: 'null'
                          description: Where this group's invoices go.
                        chargebeeCustomerId:
                          anyOf:
                          - type: string
                          - type: 'null'
                          description: The billing customer linked by Brix; null until linked.
                        chargebeeSubscriptionId:
                          anyOf:
                          - type: string
                          - type: 'null'
                          description: The subscription linked by Brix; null until linked.
                        subscriptionStatus:
                          anyOf:
                          - type: string
                          - type: 'null'
                        paymentTermsDays:
                          anyOf:
                          - type: integer
                          - type: 'null'
                          description: Net payment terms in days; null = the workspace default.
                        screenCount:
                          type: integer
                          description: Screens billed to this group.
                      required:
                      - id
                      - name
                      - financeContactName
                      - financeContactEmail
                      - chargebeeCustomerId
                      - chargebeeSubscriptionId
                      - subscriptionStatus
                      - paymentTermsDays
                      - screenCount
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: You do not hold the permission for the whole workspace (a grant at one location is not enough).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - billing.view
    post:
      operationId: createBillingGroup
      tags:
      - billing-groups
      summary: Create billing group
      description: 'Creates a billing group with a name and finance contact. Connecting it to an account with the billing provider is a separate step; one is never created automatically here.


        **Notes.**

        - The group bills nothing until Brix links it to a billing account.'
      x-brix-permission: billing.edit
      x-brix-schema: verified
      x-brix-notes:
      - The group bills nothing until Brix links it to a billing account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                financeContactName:
                  type: string
                financeContactEmail:
                  description: Stored in lower case.
                  type: string
                paymentTermsDays:
                  description: Net terms in days; rounded. Not range-checked on create.
                  type: number
              required:
              - name
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BillingGroup'
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: You do not hold the permission for the whole workspace (a grant at one location is not enough).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`name` missing.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - billing.edit
  /v1/billing-groups/{id}:
    delete:
      operationId: deleteBillingGroup
      tags:
      - billing-groups
      summary: Delete billing group
      description: Soft-deletes a billing group. Returns 409 if any screens are still billed to it; move or remove those screens first.
      x-brix-permission: billing.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Billing group id.
        example: bgrp_5e6f7a8b9c0d1e2f
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      deleted:
                        type: boolean
                        const: true
                    required:
                    - id
                    - deleted
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: You do not hold the permission for the whole workspace (a grant at one location is not enough).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: '`group_in_use`: screens still bill to it; move them first (`PATCH /v1/screens/:id` `billingGroupId`).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - billing.edit
    get:
      operationId: getBillingGroup
      tags:
      - billing-groups
      summary: Get billing group
      description: Returns one billing group by id.
      x-brix-permission: billing.view
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Billing group id.
        example: bgrp_5e6f7a8b9c0d1e2f
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BillingGroup'
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: You do not hold the permission for the whole workspace (a grant at one location is not enough).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such group in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - billing.view
    patch:
      operationId: updateBillingGroup
      tags:
      - billing-groups
      summary: Update billing group
      description: 'Updates a billing group''s name, finance contact, or invoice terms.


        **Notes.**

        - `paymentTermsDays` is range-checked here (1–365) but not on create.'
      x-brix-permission: billing.edit
      x-brix-schema: verified
      x-brix-notes:
      - '`paymentTermsDays` is range-checked here (1–365) but not on create.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Billing group id.
        example: bgrp_5e6f7a8b9c0d1e2f
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                financeContactName:
                  anyOf:
                  - type: string
                  - type: 'null'
                financeContactEmail:
                  anyOf:
                  - type: string
                  - type: 'null'
                paymentTermsDays:
                  description: 1–365, or null to use the workspace default.
                  anyOf:
                  - type: number
                  - type: 'null'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BillingGroup'
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: You do not hold the permission for the whole workspace (a grant at one location is not enough).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Empty `name`, or `paymentTermsDays` outside 1–365.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - billing.edit
  /v1/billing-groups/{id}/screens:
    post:
      operationId: createBillingGroupScreen
      tags:
      - billing-groups
      summary: Assign screens to billing group
      description: Assigns a batch of screens to a billing group. This updates the destination group, every group the screens are moving from, and the workspace subscription, so screen counts and billing stay in sync.
      x-brix-permission: billing.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Billing group id.
        example: bgrp_5e6f7a8b9c0d1e2f
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                screenIds:
                  minItems: 1
                  type: array
                  items:
                    type: string
                  description: Up to 500 are read; more are ignored. Ids that are not live screens are skipped.
              required:
              - screenIds
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      assigned:
                        type: integer
                        description: Screens moved into the group.
                      skipped:
                        type: integer
                        description: Ids not moved (unknown, or already in the group).
                      screenCount:
                        type: integer
                    required:
                    - id
                    - assigned
                    - skipped
                    - screenCount
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'You lack `billing.edit` at one of the screens'' locations (the response names them in `screenIds`); nothing changes. Also: You do not hold the permission for the whole workspace (a grant at one location is not enough).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such group, or none of the ids is a live screen.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`screenIds` missing or empty.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - billing.edit
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: 'Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …'
        message:
          description: Human-readable explanation. Safe to show an operator.
          type: string
        requestId:
          description: 'Present on 5xx: quote it to support.'
          type: string
      required:
      - error
      additionalProperties: {}
      description: Error envelope returned by every failing request.
    BillingGroup:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        financeContactName:
          anyOf:
          - type: string
          - type: 'null'
        financeContactEmail:
          anyOf:
          - type: string
          - type: 'null'
          description: Where this group's invoices go.
        chargebeeCustomerId:
          anyOf:
          - type: string
          - type: 'null'
          description: The billing customer linked by Brix; null until linked.
        chargebeeSubscriptionId:
          anyOf:
          - type: string
          - type: 'null'
          description: The subscription linked by Brix; null until linked.
        subscriptionStatus:
          anyOf:
          - type: string
          - type: 'null'
        paymentTermsDays:
          anyOf:
          - type: integer
          - type: 'null'
          description: Net payment terms in days; null = the workspace default.
        screenCount:
          type: integer
          description: Screens billed to this group.
        createdAt:
          type: string
          description: ISO-8601 timestamp (UTC).
        updatedAt:
          type: string
          description: ISO-8601 timestamp (UTC).
      required:
      - id
      - name
      - financeContactName
      - financeContactEmail
      - chargebeeCustomerId
      - chargebeeSubscriptionId
      - subscriptionStatus
      - paymentTermsDays
      - screenCount
      - createdAt
      - updatedAt
      description: A group of screens billed separately (its own invoice and finance contact).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.