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

# List individual usage entries

> Returns the individual usage entries (single submitted events) for a brick, newest first, paginated via limit/offset in a {count, next, previous, results} envelope. Each entry carries the `transaction_id` accepted by PATCH /usage and DELETE /usage, enabling per-entry edit and delete.

Only entries with a transaction record are returned — entries ingested without a `transaction_id` cannot be individually managed.



## OpenAPI

````yaml https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/bricks/{brick_id}/usage/entries
openapi: 3.0.3
info:
  title: Salesbricks REST API
  version: 2.0.0
  description: API reference for external integrations
servers:
  - url: https://api.salesbricks.com/api/v2
    description: Production
  - url: https://api.staging.salesbricks.com/api/v2
    description: Staging
security:
  - ApiKeyAuth: []
tags:
  - name: Subscriptions
    description: >-
      Operations related to subscription management, including creation,
      updates, and retrieving subscription details. Subscriptions can be
      upgraded to add / remove add-ons by using the POST
      /subscriptions/{subscription_id}/upgrade endpoint and can be recasted for
      replacing the current agreement using the POST
      /subscriptions/{subscription_id}/recast endpoint
  - name: Customers
    description: >-
      Operations related to customer management, including creation, updates,
      and managing customer person objects.
  - name: Invoices
    description: Operations related to subscription's invoicing details.
  - name: Plans
    description: >-
      Operations related to listing and getting plan details including bricks in
      the plan.
  - name: Payment Methods
    description: Operations related to subscription's payment method.
paths:
  /subscriptions/{subscription_id}/bricks/{brick_id}/usage/entries:
    get:
      tags:
        - Usage
      summary: List individual usage entries
      description: >-
        Returns the individual usage entries (single submitted events) for a
        brick, newest first, paginated via limit/offset in a {count, next,
        previous, results} envelope. Each entry carries the `transaction_id`
        accepted by PATCH /usage and DELETE /usage, enabling per-entry edit and
        delete.


        Only entries with a transaction record are returned — entries ingested
        without a `transaction_id` cannot be individually managed.
      operationId: listBrickUsageEntries
      parameters:
        - in: path
          name: brick_id
          schema:
            type: string
            pattern: ^([a-zA-Z\d\-]+)$
          required: true
        - in: query
          name: from
          schema:
            type: string
          description: >-
            Start of the range (inclusive). ISO 8601 (YYYY-MM-DD or full
            datetime). Date-only values are interpreted in the subscription's
            time zone.
        - in: query
          name: limit
          schema:
            type: integer
          description: Page size. Defaults to 25, max 100.
        - in: query
          name: offset
          schema:
            type: integer
          description: Number of entries to skip.
        - in: query
          name: search
          schema:
            type: string
          description: >-
            Optional free-text filter. Matches (OR) against the
            `transaction_id`, the entry's `properties` JSON (as text), and —
            when the term parses as a number — the exact recorded value.
        - in: path
          name: subscription_id
          schema:
            type: string
            pattern: ^([a-zA-Z\d\-]+)$
          required: true
        - in: query
          name: to
          schema:
            type: string
          description: >-
            End of the range (inclusive). ISO 8601. Date-only values resolve to
            the end of that day in the subscription's time zone.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BrickUsageEntry'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                NotFoundResponse:
                  value:
                    error:
                      code: ERR_NOT_FOUND
                      message: >-
                        Not found — the resource you are looking for does not
                        exist.
                  summary: Not Found Response
          description: ''
components:
  schemas:
    BrickUsageEntry:
      type: object
      description: One individual usage entry (a single Counter/Gauge event).
      properties:
        transaction_id:
          type: string
          description: >-
            The unique identifier of this usage entry. Use it with PATCH /usage
            and DELETE /usage to update or remove the entry.
        subscription_id:
          type: string
          format: uuid
        brick_id:
          type: string
          format: uuid
        value:
          type: number
          format: double
          maximum: 100000000000000
          minimum: -100000000000000
          exclusiveMaximum: true
          exclusiveMinimum: true
          description: >-
            The recorded usage value. Integer for whole quantities, decimal for
            fractional.
        time:
          type: string
          format: date-time
          description: The timestamp the usage was recorded against.
        properties:
          nullable: true
      required:
        - brick_id
        - subscription_id
        - time
        - transaction_id
        - value
    ErrorResponse:
      type: object
      description: >-
        Standardizes API error responses with a consistent structure containing
        error code and message.
      properties:
        error:
          $ref: '#/components/schemas/Error'
      required:
        - error
    Error:
      type: object
      description: >-
        Represents individual error details with a standardized code and
        descriptive message.
      properties:
        code:
          enum:
            - ERR_NOT_FOUND
            - ERR_BAD_REQUEST
            - ERR_SERVER_ERROR
          type: string
          x-spec-enum-id: dc5a5d6feae1b697
          description: >-
            Error code indicating the type of error: NOT_FOUND for missing
            resources, BAD_REQUEST for invalid input, SERVER_ERROR for internal
            server issues


            * `ERR_NOT_FOUND` - ERR_NOT_FOUND

            * `ERR_BAD_REQUEST` - ERR_BAD_REQUEST

            * `ERR_SERVER_ERROR` - ERR_SERVER_ERROR
        message:
          type: string
        error_id:
          type: string
          format: uuid
          description: >-
            Correlation handle for SERVER_ERROR responses — quote this when
            contacting support; it joins to the structured server log line for
            the failure. Not present on 4xx responses.
      required:
        - code
        - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-SALESBRICKS-KEY
      description: API key for authentication

````

## Related topics

- [Create a usage entry](/api-reference/usage/create-a-usage-entry.md)
- [Delete a usage entry](/api-reference/usage/delete-a-usage-entry.md)
- [Update a usage entry](/api-reference/usage/update-a-usage-entry.md)
