orb-billing
Version:
The official TypeScript library for the Orb API
28 lines • 1.36 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../resource.mjs";
/**
* The [Event](/core-concepts#event) resource represents a usage event that has been created for a
* customer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for
* a given billing period.
*/
export class Volume extends APIResource {
/**
* This endpoint returns the event volume for an account in a
* [paginated list format](/api-reference/pagination).
*
* The event volume is aggregated by the hour and the
* [timestamp](/api-reference/event/ingest-events) field is used to determine which
* hour an event is associated with. Note, this means that late-arriving events
* increment the volume count for the hour window the timestamp is in, not the
* latest hour window.
*
* Each item in the response contains the count of events aggregated by the hour
* where the start and end time are hour-aligned and in UTC. When a specific
* timestamp is passed in for either start or end time, the response includes the
* hours the timestamp falls in.
*/
list(query, options) {
return this._client.get('/events/volume', { query, ...options });
}
}
//# sourceMappingURL=volume.mjs.map