Mayson Monorepo Documentation
    Preparing search index...

    A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.

    interface Alert {
        id: string;
        object: "billing.alert";
        alert_type: "usage_threshold";
        livemode: boolean;
        status: Stripe.Billing.Alert.Status;
        title: string;
        usage_threshold: Stripe.Billing.Alert.UsageThreshold;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "billing.alert"

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

    alert_type: "usage_threshold"

    Defines the type of the alert.

    livemode: boolean

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

    Status of the alert. This can be active, inactive or archived.

    title: string

    Title of the alert.

    Encapsulates configuration of the alert to monitor usage on a specific Billing Meter.