Mayson Monorepo Documentation
    Preparing search index...

    Interface MeterEvent

    Fix me empty_doc_string.

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

    Properties

    object created event_name identifier livemode payload timestamp

    Properties

    object: "v2.billing.meter_event"

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

    created: string

    The creation time of this meter event.

    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. If not provided, one will be generated. We recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period.

    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 must contain 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: string

    The time of the event. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.

    Settings

    Member Visibility

    On This Page

    Properties