Mayson Monorepo Documentation
    Preparing search index...

    Interface MeterListEventSummariesParams

    https://stripe.com/docs/api/pagination

    interface MeterListEventSummariesParams {
        customer: string;
        end_time: number;
        start_time: number;
        expand?: string[];
        value_grouping_window?: ValueGroupingWindow;
        ending_before?: string;
        limit?: number;
        starting_after?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    customer end_time start_time expand? value_grouping_window? ending_before? limit? starting_after?

    Properties

    customer: string

    The customer for which to fetch event summaries.

    end_time: number

    The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.

    start_time: number

    The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    value_grouping_window?: ValueGroupingWindow

    Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).

    ending_before?: string

    A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

    limit?: number

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    starting_after?: string

    A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

    Settings

    Member Visibility

    On This Page

    Properties