> ## 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.json get /usage
openapi: 3.0.0
info:
  title: Noonum API
  version: 1.0.0
  contact:
    name: Noonum Support
    email: hello@noonum.com
  description: >
    Create, read, update, and delete your own investment strategies, browse
    public premade strategies, run semantic search, and call supporting utility
    endpoints.
servers:
  - url: https://api.noonum.ai/v1
security:
  - bearerAuth: []
tags:
  - name: UserStrategies
    description: Create, read, update, and delete your own investment strategies.
  - name: PremadeStrategies
    description: Read public premade strategies and find the ones closest to an objective.
  - name: Helper
    description: >-
      Supporting endpoints for company lookup, objective editing, and health
      checks.
  - name: Benchmarks
    description: Read benchmark data.
  - name: Portfolios
    description: Create, read, update, and delete your portfolios.
  - name: Backtest
    description: Backtest a portfolio without saving it.
  - 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.v1.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:
                    type: string
                    description: A human-readable description of the error.
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.