Mayson Monorepo Documentation
    Preparing search index...

    Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event's payload and how to aggregate those events.

    interface MeterEvent {
        object: "billing.meter_event";
        created: number;
        event_name: string;
        identifier: string;
        livemode: boolean;
        payload: { [key: string]: string };
        timestamp: number;
    }
    Index

    Properties

    object: "billing.meter_event"

    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.

    event_name: string

    The name of the meter event. Corresponds with the event_name field on a meter.

    identifier: string

    A unique identifier for the event.

    livemode: boolean

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

    payload: { [key: string]: string }

    The payload of the event. This contains the fields corresponding to a meter's customer_mapping.event_payload_key (default is stripe_customer_id) and value_settings.event_payload_key (default is value). Read more about the payload.

    timestamp: number

    The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.