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

# List order usage meters

> Returns usage billing meters configured on the order's package, including current unbilled usage, remaining free allowance, billable quantity, and threshold warnings. The authenticated API key must own the order.



## OpenAPI

````yaml /api-reference/openapi.json get /meter/{customer_id}/get/{order_id}
openapi: 3.1.0
info:
  title: BillingServ API V2
  description: >-
    Resources and tools for developers to integrate with the BillingServ v2 API.
    v1 is deprecated; use the v2 base URL and bearer-token authentication unless
    an endpoint states otherwise.
  version: '2.0'
servers:
  - url: https://demo.onlinebillingform.com/api/v2
    description: BillingServ demo API
security:
  - bearerAuth: []
tags:
  - name: Customer
  - name: Package
  - name: Group
  - name: Country
  - name: County
  - name: VPN
  - name: Invoice
  - name: Order
  - name: Module
  - name: Report
  - name: Marketing
  - name: Setting
  - name: Checkout
  - name: Usage
paths:
  /meter/{customer_id}/get/{order_id}:
    get:
      tags:
        - Usage
      summary: List order usage meters
      description: >-
        Returns usage billing meters configured on the order's package,
        including current unbilled usage, remaining free allowance, billable
        quantity, and threshold warnings. The authenticated API key must own the
        order.
      operationId: GET_meter_customer_id_get_order_id
      parameters:
        - name: customer_id
          in: path
          required: true
          description: Customer ID that owns the order.
          schema:
            type: integer
        - name: order_id
          in: path
          required: true
          description: Order ID to retrieve usage meters for.
          schema:
            type: integer
      responses:
        '200':
          description: Usage meters returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageMetersResponse'
              example:
                success: true
                data:
                  - id: 7
                    name: Bandwidth
                    unit_label: GB
                    included_allowance: 100
                    unit_price: '0.050000'
                    usage:
                      used: 105
                      remaining_free: 0
                      remaining_free_percent: 0
                      overage_qty: 5
                      billable_qty: 5
                      current_unbilled_amount: '0.2500'
                      threshold:
                        level: warning
                        threshold: 10
                        message: Free usage is below 10%.
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                errors: Invalid API Key
        '403':
          description: Authenticated key does not have permission for this endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                errors: Insufficient permissions for this endpoint.
        '404':
          description: Order or package not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                orderNotFound:
                  summary: Order not found
                  value:
                    success: false
                    message: Order not found for this customer.
                packageNotAssigned:
                  summary: Package not assigned
                  value:
                    success: false
                    message: Package not assigned to this order.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
              example:
                success: false
                errors: Order id and customer id is required.
      security:
        - bearerAuth: []
components:
  schemas:
    UsageMetersResponse:
      type: object
      properties:
        success:
          type: boolean
          const: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/UsageMeter'
      additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        errors:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
            - type: object
              additionalProperties: true
      additionalProperties: true
    ValidationErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        errors:
          oneOf:
            - type: array
              items:
                type: string
            - type: object
              additionalProperties: true
            - type: string
      additionalProperties: true
    UsageMeter:
      type: object
      properties:
        id:
          type: integer
          description: Package usage metric ID.
        name:
          type: string
          description: Usage metric name. Use this value as `name` when recording usage.
        unit_label:
          type: string
          description: Display label for the usage unit.
        included_allowance:
          type: number
          description: Included free quantity for this metric.
        unit_price:
          type: string
          description: Overage unit price formatted with six decimal places.
        usage:
          $ref: '#/components/schemas/UsageStatus'
      additionalProperties: true
    UsageStatus:
      type: object
      properties:
        used:
          type: number
          description: Total unbilled usage recorded for this metric.
        remaining_free:
          type: number
          description: Remaining included allowance before overage billing applies.
        remaining_free_percent:
          oneOf:
            - type: number
            - type: 'null'
          description: >-
            Percentage of included allowance remaining. Null when the metric has
            no included allowance.
        overage_qty:
          type: number
          description: Quantity above the included allowance.
        billable_qty:
          type: number
          description: Quantity currently billable in arrears.
        current_unbilled_amount:
          type: string
          description: >-
            Current unbilled amount for this metric, formatted with four decimal
            places.
        threshold:
          oneOf:
            - $ref: '#/components/schemas/UsageThreshold'
            - type: 'null'
          description: >-
            Warning information when free allowance is below 25% or 10%;
            otherwise null.
      additionalProperties: true
    UsageThreshold:
      type: object
      properties:
        level:
          type: string
          example: warning
        threshold:
          type: integer
          enum:
            - 10
            - 25
        message:
          type: string
          example: Free usage is below 10%.
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Use `Authorization: Bearer <live_api_key>`.'

````