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

# Credit Usage Rollup (Admin)

> Returns the per-account rollup of credit usage over the selected period, sorted by total credits deducted descending. Each row carries the account identity (UUID + display name + primary email) and the aggregated spend so the admin dashboard can render a top-spenders table without joining client-side. Pair with [`GET /api/admins/credits/events?account_id=…&period=…`](/api-reference/admins/credits-events) to drill into the individual `usage_events` rows for a single account. Requires the authenticated account to be a Recoup admin.



## OpenAPI

````yaml api-reference/openapi/accounts.json GET /api/admins/credits/rollup
openapi: 3.1.0
info:
  title: Recoup API - Accounts
  description: >-
    API documentation for the Recoup platform - an AI agent platform for the
    music industry
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.recoupable.dev
security: []
paths:
  /api/admins/credits/rollup:
    get:
      description: >-
        Returns the per-account rollup of credit usage over the selected period,
        sorted by total credits deducted descending. Each row carries the
        account identity (UUID + display name + primary email) and the
        aggregated spend so the admin dashboard can render a top-spenders table
        without joining client-side. Pair with [`GET
        /api/admins/credits/events?account_id=…&period=…`](/api-reference/admins/credits-events)
        to drill into the individual `usage_events` rows for a single account.
        Requires the authenticated account to be a Recoup admin.
      parameters:
        - name: period
          in: query
          required: false
          description: >-
            Rollup window. `daily` = today (last 1 day), `weekly` = last 7 days,
            `monthly` = last 30 days, `all` = no cutoff (every event ever
            recorded). Defaults to `monthly`. Follows the existing admin period
            convention.
          schema:
            type: string
            enum:
              - all
              - daily
              - weekly
              - monthly
            default: monthly
        - name: limit
          in: query
          required: false
          description: >-
            Page size — number of accounts to return per request, sorted by
            total credits deducted descending. Defaults to 100; max 500.
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
        - name: page
          in: query
          required: false
          description: >-
            1-indexed page number. Server returns rows `(page - 1) * limit`
            through `page * limit - 1`. Defaults to 1. Use `total_count` in the
            response to drive a 'load more' control (`page * limit <
            total_count`).
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: Credit usage rollup retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminCreditsRollupResponse'
        '400':
          description: Invalid `period` or `limit` parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountErrorResponse'
        '401':
          description: Unauthorized - missing or invalid credentials
        '403':
          description: Forbidden - authenticated account is not a Recoup admin
        '500':
          description: Internal server error while computing the rollup
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountErrorResponse'
      security:
        - apiKeyAuth: []
        - bearerAuth: []
components:
  schemas:
    AdminCreditsRollupResponse:
      type: object
      required:
        - status
        - period
        - page
        - limit
        - total_count
        - rows
      properties:
        status:
          type: string
          enum:
            - success
            - error
          description: Status of the request
        period:
          type: string
          enum:
            - all
            - daily
            - weekly
            - monthly
          description: The period the response was computed over (echoes the request)
        page:
          type: integer
          minimum: 1
          description: 1-indexed page returned (echoes the request, or 1 if omitted)
        limit:
          type: integer
          minimum: 1
          description: >-
            Page size used for this response (echoes the request, or the default
            if omitted)
        total_count:
          type: integer
          minimum: 0
          description: >-
            Total number of distinct accounts with at least one `usage_events`
            row in the selected period (i.e. the size of the full result set
            before pagination). The client derives `has_more` as `page * limit <
            total_count` and shows 'X of Y accounts'. Computed via a
            `COUNT(DISTINCT account_id)` query alongside the paginated row
            fetch.
        rows:
          type: array
          description: >-
            Per-account credit usage totals, sorted by
            `total_credits_deducted_cents` descending
          items:
            type: object
            required:
              - account_id
              - total_credits_deducted_cents
              - event_count
            properties:
              account_id:
                type: string
                format: uuid
                description: UUID of the account
              account_name:
                type: string
                nullable: true
                description: >-
                  Display name from the `accounts` table; null if the account
                  has no name set
              account_email:
                type: string
                format: email
                nullable: true
                description: >-
                  Primary email from `account_emails` joined for human-readable
                  rows; null if no email is on file
              total_credits_deducted_cents:
                type: integer
                description: >-
                  Sum of `usage_events.credits_deducted_cents` across every
                  event for this account in the selected period
              event_count:
                type: integer
                description: Number of `usage_events` rows aggregated into this total
        error:
          type: string
          description: Error message (only present if status is 'error')
    AccountErrorResponse:
      type: object
      required:
        - status
        - message
      properties:
        status:
          type: string
          enum:
            - error
          description: Status of the request
        message:
          type: string
          description: Error message describing what went wrong
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Recoup API key. [Learn more](/quickstart#api-keys).
    bearerAuth:
      type: http
      scheme: bearer

````