stripe 22.4.0 → 22.5.0-alpha.2

package/esm/resources/Billing/AlertNotifications.d.ts

@@ -0,0 +1,75 @@
+import { OtherString } from '../../shared.js';
+export interface AlertNotification {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'billing.alert_notification';
+    /**
+     * Whether the alert was triggered or recovered.
+     */
+    action: AlertNotification.Action;
+    /**
+     * End of the aggregation period for which this notification was sent. Only present for usage threshold alerts.
+     */
+    aggregation_period_end: number | null;
+    /**
+     * Start of the aggregation period for which this notification was sent. Only present for usage threshold alerts.
+     */
+    aggregation_period_start: number | null;
+    /**
+     * ID of the billing alert that generated this notification.
+     */
+    alert: string;
+    /**
+     * The type of billing alert that generated this notification.
+     */
+    alert_type: AlertNotification.AlertType;
+    /**
+     * The billing cadence associated with this notification. Only present for spend threshold alerts grouped by billing cadence.
+     */
+    cadence: string | null;
+    /**
+     * Three-letter ISO currency code for the value, in lowercase. Only present for spend and credit balance threshold alerts.
+     */
+    currency: string | null;
+    /**
+     * Custom pricing unit for the threshold value
+     */
+    custom_pricing_unit?: string | null;
+    /**
+     * ID of the customer for which the alert notification was sent.
+     */
+    customer: string;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * ID of the billing meter associated with this notification. Only present for usage threshold alerts.
+     */
+    meter: string | null;
+    /**
+     * ID of the event delivered for this notification. Retrievable via the Events API for a limited time; for long-term audit scenarios, capture the full event payload at webhook delivery time.
+     */
+    notification_event: string;
+    /**
+     * Time at which the notification was sent. Measured in seconds since the Unix epoch.
+     */
+    notified_at: number;
+    /**
+     * ID of the subscription associated with this notification. Only present for spend threshold alerts grouped by subscription.
+     */
+    subscription: string | null;
+    /**
+     * The value that triggered the alert. This may be a decimal string for custom pricing unit alerts. For usage threshold alerts, this is the meter event count. For credit balance and spend threshold alerts, this is the amount in the smallest currency unit.
+     */
+    value: string;
+}
+export declare namespace AlertNotification {
+    type Action = 'recovered' | 'triggered' | OtherString;
+    type AlertType = 'credit_balance_threshold' | 'spend_threshold' | 'usage_threshold' | OtherString;
+}

package/esm/resources/Billing/AlertNotifications.js

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec
+export {};
+//# sourceMappingURL=AlertNotifications.js.map

package/esm/resources/Billing/AlertNotifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlertNotifications.js","sourceRoot":"","sources":["../../../src/resources/Billing/AlertNotifications.ts"],"names":[],"mappings":"AAAA,uCAAuC"}

package/esm/resources/Billing/AlertRecovereds.d.ts

@@ -0,0 +1,56 @@
+import { Alert } from './Alerts.js';
+import { Decimal } from '../../shared.js';
+export interface AlertRecovered {
+    /**
+     * String representing the object's type. Objects of the same type share the same value.
+     */
+    object: 'billing.alert_recovered';
+    /**
+     * The aggregation period for which this alert recovered
+     */
+    aggregation_period?: AlertRecovered.AggregationPeriod | null;
+    /**
+     * 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.
+     */
+    alert: Alert;
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+    /**
+     * Currency for the threshold value
+     */
+    currency?: string | null;
+    /**
+     * Custom pricing unit for the threshold value
+     */
+    custom_pricing_unit?: string | null;
+    /**
+     * ID of customer for which the alert recovered
+     */
+    customer: string;
+    /**
+     * External customer ID for the customer for which the alert recovered
+     */
+    external_customer_id?: string | null;
+    /**
+     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+     */
+    livemode: boolean;
+    /**
+     * The value at which the alert recovered
+     */
+    value: Decimal;
+}
+export declare namespace AlertRecovered {
+    interface AggregationPeriod {
+        /**
+         * End time of the aggregation period
+         */
+        ends_at: number;
+        /**
+         * Start time of the aggregation period
+         */
+        starts_at: number;
+    }
+}

package/esm/resources/Billing/AlertRecovereds.js

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec
+export {};
+//# sourceMappingURL=AlertRecovereds.js.map

package/esm/resources/Billing/AlertRecovereds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlertRecovereds.js","sourceRoot":"","sources":["../../../src/resources/Billing/AlertRecovereds.ts"],"names":[],"mappings":"AAAA,uCAAuC"}

package/esm/resources/Billing/AlertTriggereds.d.ts

@@ -1,9 +1,14 @@
 import { Alert } from './Alerts.js';
+import { Decimal, OtherString } from '../../shared.js';
 export interface AlertTriggered {
     /**
      * String representing the object's type. Objects of the same type share the same value.
      */
     object: 'billing.alert_triggered';
+    /**
+     * The aggregation period for which this alert triggered
+     */
+    aggregation_period?: AlertTriggered.AggregationPeriod | null;
     /**
      * 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.
      */
@@ -12,16 +17,65 @@ export interface AlertTriggered {
      * Time at which the object was created. Measured in seconds since the Unix epoch.
      */
     created: number;
+    /**
+     * Currency for the threshold value
+     */
+    currency?: string | null;
+    /**
+     * Custom pricing unit for the threshold value
+     */
+    custom_pricing_unit?: string | null;
     /**
      * ID of customer for which the alert triggered
      */
     customer: string;
+    /**
+     * External customer ID for the customer for which the alert triggered
+     */
+    external_customer_id?: string | null;
+    /**
+     * Populated specifically for spend alerts to notify merchants which group_by entity has the exceeded spend
+     */
+    group_by?: AlertTriggered.GroupBy | null;
     /**
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
      */
     livemode: boolean;
+    /**
+     * Timestamp at which the threshold was crossed
+     */
+    triggered_at?: number | null;
     /**
      * The value triggering the alert
      */
-    value: number;
+    value: Decimal;
+}
+export declare namespace AlertTriggered {
+    interface AggregationPeriod {
+        /**
+         * End time of the aggregation period
+         */
+        ends_at: number;
+        /**
+         * Start time of the aggregation period
+         */
+        starts_at: number;
+    }
+    interface GroupBy {
+        /**
+         * The billing cadence ID, populated when type is `billing_cadence`
+         */
+        billing_cadence: string | null;
+        /**
+         * The pricing plan subscription ID, populated when type is `pricing_plan_subscription`
+         */
+        pricing_plan_subscription: string | null;
+        /**
+         * The type of grouping used for this alert notification
+         */
+        type: GroupBy.Type;
+    }
+    namespace GroupBy {
+        type Type = 'billing_cadence' | 'pricing_plan_subscription' | OtherString;
+    }
 }