> ## Documentation Index
> Fetch the complete documentation index at: https://developer.usetyms.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add seats

> Grant Plus seats from partner holding. First call activates Plus for the requested period; later calls add prorated seats for the remaining period.

<Warning>Requires `credit_from_referral_partner: false` at registration. Holding cost: **150 × seats × months** on first grant (default 150 credits per seat per month). Adding seats mid-period is prorated. Fails if the business already has its own active Plus subscription.</Warning>


## OpenAPI

````yaml /openapi/adam-v1.json post /referred-businesses/{business_uuid}/add-seats
openapi: 3.0.3
info:
  title: Tyms Developer API
  version: 1.0.0
  description: >-
    REST API for Tyms — the AI-Native Accounting Platform for small and
    medium-sized businesses across service, consulting, retail, and
    manufacturing. Paths are appended to the server URL.


    **Business key** (`tyms_sk_...`): all routes except partner distributor
    routes and OAuth authorization steps that document their own auth. **Partner
    key** (`adam_partner_sk_...` or equivalent): `POST /register-business`, `GET
    /referred-businesses`, billing status, and seat/credit grants on referred
    businesses. **OAuth**: integration apps use `tyms_pk_...` / `tyms_sk_...`
    plus user Bearer tokens — see the OAuth guide.


    Financial reports match what you see in the Tyms app. AI create endpoints
    accept optional attachment objects (`name`, `file`, `type`) — see the
    Attachments page in this docs site.
servers:
  - url: https://api.usetyms.com/v1/adam
    description: Production
  - url: https://staging-api.usetyms.com/v1/adam
    description: Sandbox (pre-production). Request credentials at developer@usetyms.com.
security:
  - apiKey: []
tags:
  - name: Partners
    description: >-
      Referral partner (distributor) flows — partner API key only. Register
      businesses, list referrals, read billing, and grant Plus seats or AI
      credits from partner holding.
  - name: Authentication
    description: Validate a business Developer API key.
  - name: OAuth
    description: >-
      Third-party integration authorization — connect Tyms users to your app
      without sharing their business secret keys.
  - name: Chart of accounts
    description: COA and bank-linked accounts.
  - name: Invoices
    description: Invoice CRUD and payments.
  - name: Bills
    description: Bill CRUD and payments.
  - name: Expenses
    description: Expense CRUD.
  - name: Income
    description: Income record CRUD.
  - name: Journals
    description: Journal entry CRUD.
  - name: Contacts
    description: Contact CRUD.
  - name: Banks
    description: Bank accounts.
  - name: Bank transactions
    description: Statement lines and AI-assisted upload.
  - name: Reports
    description: Financial statements (aligned with in-app reports).
paths:
  /referred-businesses/{business_uuid}/add-seats:
    post:
      tags:
        - Partners
      summary: Add seats
      description: >-
        Grant Plus seats from partner holding. First call activates Plus for the
        requested period; later calls add prorated seats for the remaining
        period.
      operationId: addReferredBusinessSeats
      parameters:
        - name: business_uuid
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddSeatsRequest'
      responses:
        '200':
          description: Seats granted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddSeatsSuccess'
              example:
                status: success
                message: Plus seats granted successfully.
                data:
                  allocation:
                    uuid: f8e2a1b0c3d4
                    allocation_type: seats
                    quantity: 450
                    seats: 3
                    months: 1
                    prorated: false
                    resulting_seats: 3
                    subscription_reference: partner_alloc_9c4f2a
                    subscription_expires_at: '2026-08-09T02:00:00.000000Z'
                    meta:
                      holding_credits_charged: 450
                      credits_granted: 450
                  holding_credits_charged: 450
                  partner_holding_balance: 9550
                  subscription_expires_at: '2026-08-09T02:00:00.000000Z'
                  transaction_credits_granted: 450
        '400':
          description: >-
            Managed-credit business, existing self-paid subscription, or
            incompatible billing state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Invalid partner key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Insufficient partner holding balance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: failed
                message: Insufficient partner credit holding.
                error_code: insufficient_partner_credit_holding
        '403':
          description: Partner inactive or business not referred by you
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Business not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AddSeatsRequest:
      type: object
      required:
        - seats
      properties:
        seats:
          type: integer
          minimum: 1
          maximum: 500
          description: Plus seats to grant, or add when a partner grant is already active.
        months:
          type: integer
          minimum: 1
          maximum: 24
          default: 1
          description: >-
            Length of the Plus period. Used on the **first** grant only; ignored
            when adding seats mid-period (remaining time is prorated).
      example:
        seats: 3
        months: 1
    AddSeatsSuccess:
      type: object
      properties:
        status:
          type: string
          example: success
        message:
          type: string
        data:
          type: object
          properties:
            allocation:
              $ref: '#/components/schemas/PartnerAllocation'
            holding_credits_charged:
              type: number
            partner_holding_balance:
              type: number
            subscription_expires_at:
              type: string
              format: date-time
            resulting_seats:
              type: integer
            transaction_credits_granted:
              type: number
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: failed
        message:
          type: string
    PartnerAllocation:
      type: object
      properties:
        uuid:
          type: string
        allocation_type:
          type: string
          enum:
            - seats
            - credits
        quantity:
          type: integer
          description: Holding credits charged (rounded up).
        seats:
          type: integer
          nullable: true
        months:
          type: integer
          nullable: true
        prorated:
          type: boolean
        proration_factor:
          type: number
          nullable: true
        resulting_seats:
          type: integer
          nullable: true
        subscription_reference:
          type: string
        subscription_starts_at:
          type: string
          format: date-time
          nullable: true
        subscription_expires_at:
          type: string
          format: date-time
          nullable: true
        meta:
          type: object
          properties:
            holding_credits_charged:
              type: number
            credits_granted:
              type: number
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Business secret `tyms_sk_...` for business-scoped routes. Partner secret
        for register-business and referred-business distributor routes.
      x-default: your_tyms_sk_or_partner_key

````