Fetch usage summaries for a plan and customer | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.plans.getUsage("planId", {
        externalId: "externalId",
    });
}
main();

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "eventName": "api_calls",
      "eventsQuantity": 1500,
      "startDate": "2024-01-01T00:00:00Z",
      "endDate": "2024-01-31T23:59:59Z",
      "subtotal": 50000,
      "nextBillingDate": "2024-02-01T00:00:00Z",
      "customerId": "7d0b6fce-d82a-433d-8315-c994f8f1d68d",
      "orderId": "8e1c7fdf-e93b-52e5-b827-557766661111",
      "orderLineId": "9f2d8eeg-f04c-63f6-c938-668877772222",
      "orderLineAttributeId": "0a3e9ffh-g15d-74g7-d049-779988883333",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "invoiceId": null,
      "invoiceLineId": null,
      "order": {
        "id": "8e1c7fdf-e93b-52e5-b827-557766661111",
        "displayId": "ORD-12345"
      },
      "orderLine": {
        "id": "9f2d8eeg-f04c-63f6-c938-668877772222",
        "displayId": "OL-67890"
      }
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "total": 1,
    "hasMore": false
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

planIdstringRequiredformat: "uuid"

The ID of the plan

Query parameters

externalIdstringRequired

The external ID of the customer

limitintegerOptional1-1000Defaults to 100

Maximum number of usage summaries to return (1-1000)

offsetintegerOptional>=0Defaults to 0

Number of usage summaries to skip for pagination

startTimedatetimeOptional

Filter usage summaries starting from this time (ISO 8601 format). Returns summaries that overlap with the time range.

endTimedatetimeOptional

Filter usage summaries up to this time (ISO 8601 format). Returns summaries that overlap with the time range.

Response

Success response

datalist of objects

paginationobject

Pagination metadata for usage summaries

Authentication

Path parameters

Query parameters

Response

Errors