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

# Subscribe to companies

> Subscribes you to each company for 365 days. A subscription cannot be cancelled or moved to another company. A company you are already subscribed to is left as it is and does not count again. The request is all or nothing: when the new subscriptions do not fit under your plan's limit, none is made. Take the company IDs from `/helper/companies/search`.



## OpenAPI

````yaml /api-reference/openapi-v2.json post /segments/subscriptions
openapi: 3.0.0
info:
  title: Noonum API v2
  version: 2.0.0
  contact:
    name: Noonum Support
    email: hello@noonum.com
  description: >
    Create and manage investment strategies, portfolios, and backtests. The API
    covers the full strategy lifecycle, including creation and editing, the
    archive and revive flow, version submission and run state, result companies,
    evidence, factsheets, exposures, and taxonomy.
servers:
  - url: https://api.noonum.ai/v2
security:
  - bearerAuth: []
tags:
  - name: UserStrategies
    description: Create, read, update, and manage your own investment strategies.
  - name: Helper
    description: >-
      Shared utilities for company lookup and search, objective tooling, and a
      health check.
  - name: Portfolios
    description: Create, read, update, and delete portfolios.
  - name: Backtest
    description: Run a standalone backtest on a portfolio of companies.
  - name: Segments
    description: >-
      Companies' business segments, grouped into segment groups and tagged to
      GICS, NAICS and ICB industries, and the companies most similar to a
      company by the segments they share. You read a company's segment data once
      you subscribe to the company. A subscription lasts 365 days and cannot be
      cancelled or moved to another company; your plan sets how many you can
      hold at once, and `GET /segments/subscriptions` lists them.
  - name: Usage
    description: Read your plan, your remaining credits, and your credit usage.
paths:
  /segments/subscriptions:
    post:
      tags:
        - Segments
      summary: Subscribe to companies
      description: >-
        Subscribes you to each company for 365 days. A subscription cannot be
        cancelled or moved to another company. A company you are already
        subscribed to is left as it is and does not count again. The request is
        all or nothing: when the new subscriptions do not fit under your plan's
        limit, none is made. Take the company IDs from
        `/helper/companies/search`.
      operationId: app.api.v2.segments.subscribe
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - companyIds
              properties:
                companyIds:
                  type: array
                  minItems: 1
                  items:
                    type: string
                    format: uuid
      responses:
        '200':
          description: Your subscriptions to the companies of the request.
          content:
            application/json:
              schema:
                type: object
                required:
                  - results
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      required:
                        - companyId
                        - name
                        - symbol
                        - subscribedAt
                        - expiresAt
                      properties:
                        companyId:
                          type: string
                          format: uuid
                        name:
                          type: string
                          nullable: true
                        symbol:
                          type: string
                          nullable: true
                        subscribedAt:
                          type: string
                          format: date-time
                        expiresAt:
                          description: When the subscription ends.
                          type: string
                          format: date-time
        '400':
          description: >-
            A company ID is not a valid UUID, or `companyIds` is missing or
            empty.
          content:
            application/json:
              schema:
                type: object
                description: A standard error response.
                properties:
                  error:
                    description: A human-readable description of the error.
                    type: string
        '403':
          description: Your plan does not include segment data.
          content:
            application/json:
              schema:
                type: object
                description: A standard error response.
                properties:
                  error:
                    description: A human-readable description of the error.
                    type: string
        '404':
          description: A company was not found; `companyIds` names them.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - companyIds
                properties:
                  error:
                    type: string
                  companyIds:
                    type: array
                    items:
                      type: string
                      format: uuid
        '409':
          description: This login's email already belongs to another Noonum account.
          content:
            application/json:
              schema:
                type: object
                description: A standard error response.
                properties:
                  error:
                    description: A human-readable description of the error.
                    type: string
        '429':
          description: The new subscriptions do not fit under your plan's limit.
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - available
                  - requested
                properties:
                  error:
                    type: string
                  available:
                    description: Subscriptions your plan still has room for.
                    type: integer
                  requested:
                    description: New subscriptions the request needed.
                    type: integer
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or API Key
      description: |
        Enter 'Bearer' followed by a space and then your JWT or API Key.
        Example: `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`
        or `Bearer YOUR_API_KEY_HERE`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.