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

# Get organization usage

> Returns the current billing period usage for all tracked metrics.



## OpenAPI

````yaml https://api.surnex.io/openapi.json get /v1/organizations/{org_id}/billing/usage
openapi: 3.1.0
info:
  title: Surnex API
  description: |-
    Surnex SEO Platform API — api.surnex.io

    Provides the complete backend for the Surnex SEO dashboard including:
    - Multi-tenant organization management
    - Project tracking (domains)
    - Keyword rank tracking (Phase 1+)
    - Backlink analysis (Phase 3+)
    - Site auditing (Phase 4+)
    - Stripe billing integration
    - MCP endpoint for AI agents at /mcp
  version: 0.1.0
servers: []
security: []
paths:
  /v1/organizations/{org_id}/billing/usage:
    get:
      tags:
        - Billing
      summary: Get organization usage
      description: Returns the current billing period usage for all tracked metrics.
      operationId: get_usage_v1_organizations__org_id__billing_usage_get
      parameters:
        - name: org_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Org Id
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse_UsageResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    APIResponse_UsageResponse_:
      properties:
        success:
          type: boolean
          title: Success
          default: true
        data:
          anyOf:
            - $ref: '#/components/schemas/UsageResponse'
            - type: 'null'
      type: object
      title: APIResponse[UsageResponse]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UsageResponse:
      properties:
        org_id:
          type: string
          format: uuid
          title: Org Id
        period_start:
          type: string
          format: date
          title: Period Start
        period_end:
          type: string
          format: date
          title: Period End
        metrics:
          items:
            $ref: '#/components/schemas/UsageMetricResponse'
          type: array
          title: Metrics
      type: object
      required:
        - org_id
        - period_start
        - period_end
        - metrics
      title: UsageResponse
      description: Full usage summary for an organization in the current billing period.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    UsageMetricResponse:
      properties:
        metric:
          type: string
          title: Metric
        count:
          type: integer
          title: Count
        limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Limit
          description: Plan limit for this metric. None means unlimited.
        period_start:
          type: string
          format: date
          title: Period Start
        period_end:
          type: string
          format: date
          title: Period End
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - metric
        - count
        - period_start
        - period_end
        - updated_at
      title: UsageMetricResponse
      description: Usage data for a single metric in the current billing period.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````