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

# Get month-to-date usage total



## OpenAPI

````yaml /api-reference/specs/billing.yaml get /v1/usage
openapi: 3.0.3
info:
  title: Basaltic Billing API
  version: 1.0.0
  description: |
    Prices, metered usage, invoices, payments and credits — what the account
    has consumed and been charged. The price catalog (`/v1/prices`) is
    public; everything else is scoped to the calling account.

    Read-only. Settling an invoice and managing payment methods happen in the
    console.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://billing.basaltic.sh
    description: Global API endpoint
security:
  - SignatureAuth: []
paths:
  /v1/usage:
    get:
      tags:
        - Billing
      summary: Get month-to-date usage total
      operationId: getCurrentUsage
      responses:
        '200':
          description: Unbilled usage accrued in the current UTC month.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentUsage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - SignatureAuth: []
components:
  schemas:
    CurrentUsage:
      type: object
      required:
        - amount
        - period_start
        - items
      properties:
        amount:
          type: string
          description: Unbilled usage accrued this UTC month, 2-decimal string.
          example: '42.87'
        period_start:
          type: string
          format: date-time
          example: '2026-07-01T00:00:00Z'
        items:
          type: array
          description: Per-SKU breakdown, ordered by cost.
          items:
            $ref: '#/components/schemas/UsageLine'
    UsageLine:
      type: object
      required:
        - sku
        - description
        - quantity
        - unit
        - amount
      properties:
        sku:
          type: string
          example: compute.instance.m1.small
        description:
          type: string
          example: m1.small
        quantity:
          type: string
          example: '412.5'
        unit:
          type: string
          example: hour
        amount:
          type: string
          description: >-
            Accrued cost at 4-decimal precision (sub-centavo lines stay visible
            mid-month).
          example: '26.8125'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    Unauthorized:
      description: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    SignatureAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Request signing with an access key issued to a service account. An

        HMAC-SHA256 over a canonical form of the request, close to AWS SigV4.

        The `basaltic` CLI signs for you.


        Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce`

        (random per request); add `X-Content-Sha256` to bind a body, and

        `X-Amz-Security-Token` when using temporary credentials.


        ```

        Authorization: BASALTIC-HMAC-SHA256
        Credential=<access_key_id>/<date>/<region>/basaltic/basaltic_request,
        SignedHeaders=host;x-date;x-nonce, Signature=<hex>

        ```


        `<region>` is the region code you are calling, or `global` for the
        global

        services. A signature is valid for 5 minutes from `X-Date`, and mutating

        requests are replay-guarded on the nonce.


        **Full signing procedure, including a working implementation:**

        https://docs.basaltic.sh/authentication


        ## Rate limits

        There is no global request budget. A limit applies only where an

        operation documents a `429`, and that operation says what it counts.

        Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`,

        `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather

        than hard-coding a number. Retrying before `Retry-After` is refused and

        extends the window. Everything else is bounded by quota, not by request

        rate.

````