stripe 20.0.0 → 20.1.0-alpha.2

package/types/Billing/AlertsResource.d.ts

@@ -7,13 +7,18 @@ declare module 'stripe' {
         /**
          * The type of alert to create.
          */
-        alert_type: 'usage_threshold';
+        alert_type: AlertCreateParams.AlertType;
 
         /**
          * The title of the alert.
          */
         title: string;
 
+        /**
+         * The configuration of the credit balance threshold.
+         */
+        credit_balance_threshold?: AlertCreateParams.CreditBalanceThreshold;
+
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -26,6 +31,139 @@ declare module 'stripe' {
       }
 
       namespace AlertCreateParams {
+        type AlertType = 'credit_balance_threshold' | 'usage_threshold';
+
+        interface CreditBalanceThreshold {
+          /**
+           * The filters allows limiting the scope of this credit balance alert. You must specify a customer filter at this time.
+           */
+          filters?: Array<CreditBalanceThreshold.Filter>;
+
+          /**
+           * Defines at which value the alert will fire.
+           */
+          lte: CreditBalanceThreshold.Lte;
+        }
+
+        namespace CreditBalanceThreshold {
+          interface Filter {
+            /**
+             * The credit grants for which to configure the credit balance alert.
+             */
+            credit_grants?: Filter.CreditGrants;
+
+            /**
+             * Limit the scope to this credit balance alert only to this customer.
+             */
+            customer?: string;
+
+            /**
+             * What type of filter is being applied to this credit balance alert.
+             */
+            type: Filter.Type;
+          }
+
+          namespace Filter {
+            interface CreditGrants {
+              /**
+               * The applicability configuration for this credit grants filter.
+               */
+              applicability_config: CreditGrants.ApplicabilityConfig;
+            }
+
+            namespace CreditGrants {
+              interface ApplicabilityConfig {
+                /**
+                 * Specify the scope of this applicability config.
+                 */
+                scope: ApplicabilityConfig.Scope;
+              }
+
+              namespace ApplicabilityConfig {
+                interface Scope {
+                  /**
+                   * A list of billable items that the credit grant can apply to. We currently only support metered billable items. Cannot be used in combination with `price_type` or `prices`.
+                   */
+                  billable_items?: Array<Scope.BillableItem>;
+
+                  /**
+                   * The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
+                   */
+                  price_type?: 'metered';
+
+                  /**
+                   * A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.
+                   */
+                  prices?: Array<Scope.Price>;
+                }
+
+                namespace Scope {
+                  interface BillableItem {
+                    /**
+                     * The billable item ID this credit grant should apply to.
+                     */
+                    id: string;
+                  }
+
+                  interface Price {
+                    /**
+                     * The price ID this credit grant should apply to.
+                     */
+                    id: string;
+                  }
+                }
+              }
+            }
+
+            type Type = 'customer' | 'tenant';
+          }
+
+          interface Lte {
+            /**
+             * Specify the type of this balance. We currently only support `monetary` billing credits.
+             */
+            balance_type: Lte.BalanceType;
+
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: Lte.CustomPricingUnit;
+
+            /**
+             * The monetary amount.
+             */
+            monetary?: Lte.Monetary;
+          }
+
+          namespace Lte {
+            type BalanceType = 'custom_pricing_unit' | 'monetary';
+
+            interface CustomPricingUnit {
+              /**
+               * The ID of the custom pricing unit.
+               */
+              id: string;
+
+              /**
+               * A positive decimal string representing the amount of the custom pricing unit threshold.
+               */
+              value: string;
+            }
+
+            interface Monetary {
+              /**
+               * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
+               */
+              currency: string;
+
+              /**
+               * An integer representing the amount of the threshold.
+               */
+              value: number;
+            }
+          }
+        }
+
         interface UsageThreshold {
           /**
            * The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.
@@ -74,7 +212,12 @@ declare module 'stripe' {
         /**
          * Filter results to only include this type of alert.
          */
-        alert_type?: 'usage_threshold';
+        alert_type?: AlertListParams.AlertType;
+
+        /**
+         * Filter results to only include alerts for the given customer.
+         */
+        customer?: string;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -87,6 +230,10 @@ declare module 'stripe' {
         meter?: string;
       }
 
+      namespace AlertListParams {
+        type AlertType = 'credit_balance_threshold' | 'usage_threshold';
+      }
+
       interface AlertActivateParams {
         /**
          * Specifies which fields in the response should be expanded.

package/types/Billing/Analytics/MeterUsage.d.ts

@@ -0,0 +1,31 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Billing {
+      namespace Analytics {
+        /**
+         * A billing meter usage event represents an aggregated view of a customer's billing meter events within a specified timeframe.
+         */
+        interface MeterUsage {
+          /**
+           * String representing the object's type. Objects of the same type share the same value.
+           */
+          object: 'billing.analytics.meter_usage';
+
+          /**
+           * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+           */
+          livemode: boolean;
+
+          /**
+           * The timestamp to indicate data freshness, measured in seconds since the Unix epoch.
+           */
+          refreshed_at: number;
+
+          rows: ApiList<Stripe.Billing.Analytics.MeterUsageRow>;
+        }
+      }
+    }
+  }
+}