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

# Get customer usage

> Returns an enrollment's usage totals per meter over a time window. Without `from`, the window starts on the first day of the current month (UTC); without `to`, it ends now. `to` must be after `from`.




## OpenAPI

````yaml /api-reference/openapi.en.json get /metering/usage
openapi: 3.1.0
info:
  title: Infi API
  version: 0.0.1
  description: >
    The Infi REST API: catalog, customers, usage metering, subscriptions,

    invoices, payments and checkout.


    **Authentication.** Send your secret key as `Authorization: Bearer
    sk_test_…`

    (sandbox) or `sk_live_…` (production). The key prefix selects the
    environment.

    Checkout routes (`/pay/*`) and `/public/*` take no key: they run in the

    payer's browser.


    **Idempotency.** Every request that changes data requires an

    `Idempotency-Key` header. A retry with the same key returns the original

    response instead of running again.


    **Amounts.** Money and quantities travel as decimal strings (`"150.00"`,

    `"0.0001"`), never as floating-point numbers.


    **Errors.** The body carries `error_code` (stable, branch on it), `message`

    (for humans) and `tracer_id` (send it to support). Rate-limit and
    idempotency

    errors are nested under `error`, with `code` and `request_id`.
servers:
  - url: https://api-sandbox.beinfi.com
    description: Sandbox
  - url: https://api.beinfi.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Catalog
  - name: Customers
  - name: Metering
  - name: Subscriptions
  - name: Invoices
  - name: Payments
  - name: Checkout
  - name: Coupons
  - name: Billing
  - name: Account
  - name: Webhooks
  - name: Test account
  - name: Rail
  - name: Storefronts
paths:
  /metering/usage:
    get:
      tags:
        - Metering
      summary: Get customer usage
      description: >
        Returns an enrollment's usage totals per meter over a time window.
        Without `from`, the window starts on the first day of the current month
        (UTC); without `to`, it ends now. `to` must be after `from`.
      operationId: getUsage
      parameters:
        - name: customerId
          in: query
          required: true
          schema:
            type: string
            format: uuid
          description: The enrollment ID.
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Window start (ISO 8601).
        - name: to
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Window end (ISO 8601).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageReport'
          description: Usage report.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    UsageReport:
      type: object
      required:
        - customerId
        - from
        - to
        - meters
      properties:
        customerId:
          type: string
          format: uuid
          description: Enrollment ID.
        from:
          type: string
          format: date-time
          description: Window start.
        to:
          type: string
          format: date-time
          description: Window end.
        meters:
          type: array
          items:
            $ref: '#/components/schemas/MeterUsage'
          description: One total per meter.
      description: An enrollment's usage totals per meter over a time window.
    MeterUsage:
      type: object
      required:
        - meterId
        - meter
        - unit
        - totalValue
        - eventCount
      properties:
        meterId:
          type: string
          format: uuid
        meter:
          type: string
          description: Meter key.
        unit:
          type: string
          description: The meter's unit.
        totalValue:
          type: string
          description: Quantity summed over the window, as a decimal string.
        eventCount:
          type: integer
          description: How many events were recorded.
        totalAmount:
          type:
            - string
            - 'null'
          description: >-
            Money value of that quantity at the applicable price. Null when the
            meter has no price.
        currency:
          type:
            - string
            - 'null'
          description: Currency of `totalAmount`.
    Error:
      type: object
      required:
        - message
        - error_code
        - tracer_id
      properties:
        message:
          type: string
          description: Human-readable sentence.
        error_code:
          $ref: '#/components/schemas/ErrorCode'
          description: Stable error code. Branch on it.
        tracer_id:
          type: string
          description: Request id. Include it when contacting support.
      description: >-
        The standard error body. It is flat (no `error` wrapper) and the trace
        id is `tracer_id`.
    ErrorCode:
      type: string
      examples:
        - internal_error
        - validation_failed
        - bad_request
        - unauthorized
        - forbidden
        - not_found
        - conflict
        - rate_limited
      description: >-
        Stable error code. The list is open: besides the generic codes, each
        area defines its own (`coupon_expired`, `insufficient_balance`,
        `version_not_draft`, `idempotency_key_reused`…). Handle a code you do
        not recognize by its HTTP status and show `message`; do not fail parsing
        the response.
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Malformed request.
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Missing or invalid API key.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your account's secret key: `Authorization: Bearer sk_test_…` or
        `sk_live_…`. Server-side only.

````