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

# Get billing usage grouped by product, account, and event



## OpenAPI

````yaml /api-reference/openapi.json get /v2/billing/usage
openapi: 3.1.0
info:
  title: Base39 API
  description: Base39 API
  version: 1.0.0
  contact:
    name: Base39 Team
    url: https://base39.com.br
    email: suporte@base39.com.br
  termsOfService: https://base39.com.br/termos
  license:
    name: Proprietary
    url: https://base39.com.br/termos
servers:
  - url: http://localhost:3000
    description: Local
  - url: https://api.dev.base39.cloud
    description: Development
  - url: https://api.base39.com.br
    description: Production
security:
  - OAuth2: []
tags:
  - name: pages
    description: Profiles and reports pages
  - name: pipelines
    description: Pipeline boards (kanban) of pages
  - name: blocks
    description: Blocks operations
  - name: search
    description: Search across content
  - name: targets
    description: Lookup targets via datasets
  - name: CognitoTriggers
    description: Cognito triggers
paths:
  /v2/billing/usage:
    get:
      tags:
        - billing
      summary: Get billing usage grouped by product, account, and event
      operationId: billing_get_usage
      parameters:
        - name: date_from
          required: false
          in: query
          description: Inclusive usage period start date (yyyy-MM-dd)
          schema:
            type: string
        - name: date_to
          required: false
          in: query
          description: Inclusive usage period end date (yyyy-MM-dd)
          schema:
            type: string
        - name: account
          required: false
          in: query
          description: Organization IDs to include. Defaults to current org.
          schema:
            type: array
            items:
              type: string
        - name: product
          required: false
          in: query
          description: Product slugs to include.
          schema:
            type: array
            items:
              type: string
        - name: breakdown
          required: false
          in: query
          description: Breakdown order.
          schema:
            type: array
            items:
              type: string
              enum:
                - product
                - account
                - event
                - document
        - name: interval
          required: false
          in: query
          description: Chart/table interval.
          schema:
            default: month
            type: string
            enum:
              - none
              - day
              - week
              - month
        - name: hide_no_spend
          required: false
          in: query
          description: Hide rows without usage.
          schema:
            type: boolean
            default: false
        - name: page_size
          required: false
          in: query
          description: Rows per page for ungrouped usage.
          schema:
            maximum: 20
            default: 20
            type: number
        - name: start_cursor
          required: false
          in: query
          description: Cursor for ungrouped usage pagination.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingUsageOutput'
components:
  schemas:
    BillingUsageOutput:
      type: object
      properties:
        object:
          type: string
          description: Object type identifier
          default: list
        results:
          type: array
          items:
            $ref: '#/components/schemas/BillingUsageSeriesOutput'
        next_cursor:
          type: string
          description: Cursor for next ungrouped usage page.
          nullable: true
        has_more:
          type: boolean
          description: Whether more ungrouped usage rows exist.
      required:
        - object
        - results
        - has_more
    BillingUsageSeriesOutput:
      type: object
      properties:
        id:
          type: string
          example: '["queries","org_123","Quod Completo"]'
        label:
          type: string
          example: Consultas de dados, Base39, Quod Completo
        product:
          type: string
          example: queries
        productName:
          type: string
          example: Consultas de dados
        account:
          type: string
          example: org_123
        accountName:
          type: string
          example: Base39
        event:
          type: string
          example: Quod Completo
          nullable: true
        document:
          type: string
          example: '11222333000181'
          nullable: true
        userId:
          type: string
          example: u_123
          nullable: true
        userName:
          type: string
          example: Bruno Nunes
          nullable: true
        userEmail:
          type: string
          example: bruno@base39.com.br
          nullable: true
        amount:
          type: number
          example: 12345
        quantity:
          type: number
          example: 42
        points:
          type: array
          items:
            $ref: '#/components/schemas/BillingUsagePointOutput'
      required:
        - id
        - label
        - product
        - productName
        - account
        - accountName
        - event
        - document
        - userId
        - userName
        - userEmail
        - amount
        - quantity
        - points
    BillingUsagePointOutput:
      type: object
      properties:
        period:
          type: string
          example: 2026-06
        amount:
          type: number
          example: 12345
        quantity:
          type: number
          example: 42
      required:
        - period
        - amount
        - quantity
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://id.local.base39.cloud/oauth2/authorize
          tokenUrl: https://id.local.base39.cloud/oauth2/token
          scopes:
            profile: Read user profile
            email: Read user email
            openid: OpenID authentication
      description: OAuth2 Authorization Code flow

````