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

# Get plan consumption

> Returns credits burned per plan for the organization over an optional date range, with the number of unique users per plan. Credit amounts are serialised as strings (bigint). Requires a Nevermined API key. Requires active organization membership. Requires the organization to be on the Premium tier or higher.



## OpenAPI

````yaml /api-reference/organizations-openapi.json get /organizations/{orgId}/analytics/usage
openapi: 3.0.0
info:
  title: Nevermined Organizations API
  description: >-
    Manage a Nevermined organization programmatically — members, tiers, groups &
    budgets, treasury wallets, customers, webhooks, analytics, and
    agent-discovery surfaces.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.sandbox.nevermined.app/api/v1
    description: Sandbox
  - url: https://api.live.nevermined.app/api/v1
    description: Live
security: []
tags:
  - name: Organizations
    x-group: General
    description: Organization settings, members & roles, and workspace context.
  - name: Organizations - Billing
    x-group: Billing
    description: Tiers, subscriptions, invoices, checkout, and the public tier catalog.
  - name: Groups
    x-group: Groups & Budgets
    description: Organization groups, per-group budgets, and shared payment methods.
  - name: Organizations - Wallets
    x-group: Wallets
    description: Custodial stablecoin treasury wallets.
  - name: Organizations - Customers
    x-group: Customers
    description: The white-label customer CRM (Enterprise).
  - name: Organizations - Analytics
    x-group: Analytics
    description: Revenue, MRR, usage, conversion, and per-member metrics.
  - name: Organizations - Webhooks
    x-group: Webhooks
    description: Outbound webhook subscriptions and deliveries.
  - name: Organizations - Activity
    x-group: Activity
    description: The organization activity feed.
  - name: Organizations - Realtime
    x-group: Realtime
    description: Realtime WebSocket secret management (Enterprise).
  - name: Invitations
    x-group: Invitations
    description: Invite people to an organization.
  - name: Organizations - Integration
    x-group: Agent Discovery
    description: >-
      Public agent-discovery surfaces (llms.txt, agentic-instructions.md,
      ai-catalog.json).
paths:
  /organizations/{orgId}/analytics/usage:
    get:
      tags:
        - Organizations - Analytics
      summary: Get plan consumption
      description: >-
        Returns credits burned per plan for the organization over an optional
        date range, with the number of unique users per plan. Credit amounts are
        serialised as strings (bigint). Requires a Nevermined API key. Requires
        active organization membership. Requires the organization to be on the
        Premium tier or higher.
      operationId: OrganizationAnalyticsController_usage
      parameters:
        - name: orgId
          required: true
          in: path
          description: Organization ID
          schema:
            type: string
            example: org-abc123
        - name: limit
          required: false
          in: query
          description: Maximum number of plans to return (1–200).
          schema:
            example: 50
            type: number
        - name: to
          required: false
          in: query
          description: ISO-8601 end date (inclusive). Omit for no upper bound.
          schema:
            example: '2026-02-01T23:59:59.999Z'
            type: string
        - name: from
          required: false
          in: query
          description: ISO-8601 start date (inclusive). Omit for no lower bound.
          schema:
            example: '2026-01-01T00:00:00.000Z'
            type: string
      responses:
        '200':
          description: Plan consumption breakdown
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanConsumptionResponseDto'
        '401':
          description: Missing or invalid Nevermined API key
        '403':
          description: >-
            Caller is not an organization member, or the org is not on the
            Premium tier or higher
      security:
        - Authorization: []
components:
  schemas:
    PlanConsumptionResponseDto:
      type: object
      properties:
        items:
          description: Per-plan consumption rows.
          type: array
          items:
            $ref: '#/components/schemas/PlanConsumptionItemDto'
      required:
        - items
    PlanConsumptionItemDto:
      type: object
      properties:
        planId:
          type: string
          description: Plan ID.
          example: plan-5d8f2a
        planName:
          type: string
          description: Human-readable plan name.
          example: Pro Monthly
        creditsBurned:
          type: string
          description: >-
            Total credits burned against this plan, serialised as a string
            (bigint).
          example: '15000'
        uniqueUsers:
          type: number
          description: Number of distinct users who burned credits.
          example: 27
      required:
        - planId
        - planName
        - creditsBurned
        - uniqueUsers
  securitySchemes:
    Authorization:
      scheme: bearer
      bearerFormat: JWT
      type: http

````

## Related topics

- [Payment Plans](/docs/api-reference/typescript/payment-plans.md)
- [Get Plan](/docs/api-reference/protocol/get-plan.md)
- [Get Plan Balance](/docs/api-reference/protocol/get-plan-balance.md)
- [Get Plan Agents](/docs/api-reference/protocol/get-plan-agents.md)
- [Get Agent Plans](/docs/api-reference/protocol/get-agent-plans.md)