@limitry/client - v0.4.1
    Preparing search index...

    Class Customers

    Index

    Constructors

    constructor

    Methods

    getUsage

    Constructors

    Methods

    • Get customer usage

      Retrieve usage summary for a specific customer within a date range.

      This endpoint provides aggregated metrics for a single customer, making it ideal for:

      • Customer billing and invoicing
      • Per-tenant usage dashboards
      • Customer-specific analytics
      • Usage-based pricing calculations

      Parameters

      • customerId: string

        Customer identifier to get usage for (min length: 1)

      • startDate: string

        Start of the date range (ISO 8601 format) (ISO 8601 format, e.g., "2024-01-01T00:00:00Z")

      • endDate: string

        End of the date range (ISO 8601 format) (ISO 8601 format, e.g., "2024-01-01T00:00:00Z")

      Returns Promise<
          {
              customerId: string;
              totalCostCents: number;
              totalEvents: number;
              totalInputTokens: number;
              totalOutputTokens: number;
              totalTokens: number;
          },
      >

      Customer usage summary

      const result = await client.customers.getUsage(
        "customerid_123",
        startDate: "2024-01-01T00:00:00Z",
        endDate: "2024-01-01T00:00:00Z"
      );
      console.log(result);

      Invalid query parameters

      Unauthorized - Invalid or missing API key

      If a network error occurs

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods