Mayson Monorepo Documentation
    Preparing search index...

    Interface MeterEventCreateParams

    interface MeterEventCreateParams {
        event_name: string;
        payload: { [key: string]: string };
        expand?: string[];
        identifier?: string;
        timestamp?: number;
    }
    Index

    Properties

    event_name payload expand? identifier? timestamp?

    Properties

    event_name: string

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

    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.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    identifier?: string

    A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.

    timestamp?: number

    The time of the event. Measured in seconds since the Unix epoch. 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