Mayson Monorepo Documentation
    Preparing search index...

    Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.

    Related guide: Usage based billing

    interface Meter {
        id: string;
        object: "billing.meter";
        created: number;
        customer_mapping: Stripe.Billing.Meter.CustomerMapping;
        default_aggregation: Stripe.Billing.Meter.DefaultAggregation;
        display_name: string;
        event_name: string;
        event_time_window: Stripe.Billing.Meter.EventTimeWindow;
        livemode: boolean;
        status: Stripe.Billing.Meter.Status;
        status_transitions: Stripe.Billing.Meter.StatusTransitions;
        updated: number;
        value_settings: Stripe.Billing.Meter.ValueSettings;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "billing.meter"

    String representing the object's type. Objects of the same type share the same value.

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    default_aggregation: Stripe.Billing.Meter.DefaultAggregation
    display_name: string

    The meter's name.

    event_name: string

    The name of the meter event to record usage for. Corresponds with the event_name field on meter events.

    event_time_window: Stripe.Billing.Meter.EventTimeWindow

    The time window which meter events have been pre-aggregated for, if any.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    The meter's status.

    updated: number

    Time at which the object was last updated. Measured in seconds since the Unix epoch.