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

# Allowance and what is left



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json get /v1/organizations/{orgId}/billing/usage
openapi: 3.1.0
info:
  title: Surnex API
  version: 1.0.0
  description: >-
    The SEO platform's API.


    **The API is the product.** The dashboard is one client and the MCP server
    at `/mcp` is another. If a number needs deriving, a service derives it —
    never a React component, or the two clients drift.


    **Two kinds of auth.** The dashboard sends a Supabase access token as a
    Bearer JWT. MCP agents send `X-API-Key`, and the organization is resolved
    from the key.


    **Two data modes.** SERP results and Google Trends are fetched live on
    request. Everything else is written by the worker and read from Postgres, so
    a freshly-created project returns empty until its jobs complete.
servers:
  - url: https://api.surnex.io
    description: Surnex API
security: []
paths:
  /v1/organizations/{orgId}/billing/usage:
    get:
      tags:
        - billing
      summary: Allowance and what is left
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: orgId
          in: path
      responses:
        '200':
          description: Usage
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      plan:
                        type: string
                        nullable: true
                        enum:
                          - starter
                          - growth
                          - agency
                          - scale
                          - null
                      resets_at:
                        type: string
                        format: date-time
                      metrics:
                        type: array
                        items:
                          type: object
                          properties:
                            metric:
                              type: string
                              enum:
                                - ai_prompts
                                - keywords_tracked
                                - local_locations
                                - research_lookups
                                - ai_brand_audits
                                - site_audit_pages
                            kind:
                              type: string
                              enum:
                                - held
                                - monthly
                            used:
                              type: integer
                            limit:
                              type: integer
                            remaining:
                              type: integer
                          required:
                            - metric
                            - kind
                            - used
                            - limit
                            - remaining
                      features:
                        type: object
                        additionalProperties:
                          type: boolean
                    required:
                      - plan
                      - resets_at
                      - metrics
                      - features
                required:
                  - success
                  - data

````

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