> ## 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.

# Get your plan and remaining credits

> Returns your plan and the credits left in its current period. Each strategy run, live or historical, uses one credit, and failed runs are refunded. Credits refill at `refills_at`.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /usage
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:
  /usage:
    get:
      tags:
        - Usage
      summary: Get your plan and remaining credits
      description: >-
        Returns your plan and the credits left in its current period. Each
        strategy run, live or historical, uses one credit, and failed runs are
        refunded. Credits refill at `refills_at`.
      operationId: app.api.v2.usage.get_usage
      responses:
        '200':
          description: Your plan and credit balance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    type: string
                    description: The name of your plan.
                    example: Free
                  granted:
                    type: integer
                    nullable: true
                    description: >-
                      Credits your plan grants each period. Null on an unlimited
                      plan.
                    example: 10
                  used:
                    type: integer
                    description: Credits used in the current period.
                    example: 3
                  remaining:
                    type: integer
                    nullable: true
                    description: >-
                      Credits left in the current period. Null on an unlimited
                      plan.
                    example: 7
                  refills_at:
                    type: string
                    format: date-time
                    description: When the current period ends and your credits refill.
                    example: '2026-10-01T00:00:00+00:00'
                required:
                  - plan
                  - granted
                  - used
                  - remaining
                  - refills_at
        '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
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.