orb-billing 4.72.3 → 4.74.0

package/src/resources/invoices.ts

@@ -942,7 +942,7 @@ export namespace Invoice {
      * For more on the types of prices, see
      * [the core concepts documentation](/core-concepts#plan-and-price)
      */
-    price: PricesAPI.Price | null;
+    price: PricesAPI.Price;
 
     /**
      * Either the fixed fee quantity or the usage during the service period.
@@ -989,10 +989,15 @@ export namespace Invoice {
       amount: string;
 
       /**
-       * The price IDs that this adjustment applies to.
+       * @deprecated The price IDs that this adjustment applies to.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this adjustment to.
+       */
+      filters: Array<MonetaryUsageDiscountAdjustment.Filter>;
+
       /**
        * True for adjustments that apply to an entire invocice, false for adjustments
        * that apply to only one price.
@@ -1011,6 +1016,25 @@ export namespace Invoice {
       usage_discount: number;
     }
 
+    export namespace MonetaryUsageDiscountAdjustment {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     export interface MonetaryAmountDiscountAdjustment {
       id: string;
 
@@ -1028,10 +1052,15 @@ export namespace Invoice {
       amount_discount: string;
 
       /**
-       * The price IDs that this adjustment applies to.
+       * @deprecated The price IDs that this adjustment applies to.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this adjustment to.
+       */
+      filters: Array<MonetaryAmountDiscountAdjustment.Filter>;
+
       /**
        * True for adjustments that apply to an entire invocice, false for adjustments
        * that apply to only one price.
@@ -1044,6 +1073,25 @@ export namespace Invoice {
       reason: string | null;
     }
 
+    export namespace MonetaryAmountDiscountAdjustment {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     export interface MonetaryPercentageDiscountAdjustment {
       id: string;
 
@@ -1055,10 +1103,15 @@ export namespace Invoice {
       amount: string;
 
       /**
-       * The price IDs that this adjustment applies to.
+       * @deprecated The price IDs that this adjustment applies to.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this adjustment to.
+       */
+      filters: Array<MonetaryPercentageDiscountAdjustment.Filter>;
+
       /**
        * True for adjustments that apply to an entire invocice, false for adjustments
        * that apply to only one price.
@@ -1077,6 +1130,25 @@ export namespace Invoice {
       reason: string | null;
     }
 
+    export namespace MonetaryPercentageDiscountAdjustment {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     export interface MonetaryMinimumAdjustment {
       id: string;
 
@@ -1088,10 +1160,15 @@ export namespace Invoice {
       amount: string;
 
       /**
-       * The price IDs that this adjustment applies to.
+       * @deprecated The price IDs that this adjustment applies to.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this adjustment to.
+       */
+      filters: Array<MonetaryMinimumAdjustment.Filter>;
+
       /**
        * True for adjustments that apply to an entire invocice, false for adjustments
        * that apply to only one price.
@@ -1115,6 +1192,25 @@ export namespace Invoice {
       reason: string | null;
     }
 
+    export namespace MonetaryMinimumAdjustment {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     export interface MonetaryMaximumAdjustment {
       id: string;
 
@@ -1126,10 +1222,15 @@ export namespace Invoice {
       amount: string;
 
       /**
-       * The price IDs that this adjustment applies to.
+       * @deprecated The price IDs that this adjustment applies to.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this adjustment to.
+       */
+      filters: Array<MonetaryMaximumAdjustment.Filter>;
+
       /**
        * True for adjustments that apply to an entire invocice, false for adjustments
        * that apply to only one price.
@@ -1148,38 +1249,105 @@ export namespace Invoice {
       reason: string | null;
     }
 
+    export namespace MonetaryMaximumAdjustment {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     /**
      * @deprecated This field is deprecated in favor of `adjustments`.
      */
     export interface Maximum {
       /**
-       * List of price_ids that this maximum amount applies to. For plan/plan phase
-       * maximums, this can be a subset of prices.
+       * @deprecated List of price_ids that this maximum amount applies to. For plan/plan
+       * phase maximums, this can be a subset of prices.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this maximum to.
+       */
+      filters: Array<Maximum.Filter>;
+
       /**
        * Maximum amount applied
        */
       maximum_amount: string;
     }
 
+    export namespace Maximum {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     /**
      * @deprecated This field is deprecated in favor of `adjustments`.
      */
     export interface Minimum {
       /**
-       * List of price_ids that this minimum amount applies to. For plan/plan phase
-       * minimums, this can be a subset of prices.
+       * @deprecated List of price_ids that this minimum amount applies to. For plan/plan
+       * phase minimums, this can be a subset of prices.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this minimum to.
+       */
+      filters: Array<Minimum.Filter>;
+
       /**
        * Minimum amount applied
        */
       minimum_amount: string;
     }
 
+    export namespace Minimum {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     export interface MatrixSubLineItem {
       /**
        * The total amount for this sub line item.
@@ -1297,30 +1465,78 @@ export namespace Invoice {
 
   export interface Maximum {
     /**
-     * List of price_ids that this maximum amount applies to. For plan/plan phase
-     * maximums, this can be a subset of prices.
+     * @deprecated List of price_ids that this maximum amount applies to. For plan/plan
+     * phase maximums, this can be a subset of prices.
      */
     applies_to_price_ids: Array<string>;
 
+    /**
+     * The filters that determine which prices to apply this maximum to.
+     */
+    filters: Array<Maximum.Filter>;
+
     /**
      * Maximum amount applied
      */
     maximum_amount: string;
   }
 
+  export namespace Maximum {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   export interface Minimum {
     /**
-     * List of price_ids that this minimum amount applies to. For plan/plan phase
-     * minimums, this can be a subset of prices.
+     * @deprecated List of price_ids that this minimum amount applies to. For plan/plan
+     * phase minimums, this can be a subset of prices.
      */
     applies_to_price_ids: Array<string>;
 
+    /**
+     * The filters that determine which prices to apply this minimum to.
+     */
+    filters: Array<Minimum.Filter>;
+
     /**
      * Minimum amount applied
      */
     minimum_amount: string;
   }
 
+  export namespace Minimum {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   export interface PaymentAttempt {
     /**
      * The ID of the payment attempt.
@@ -2165,7 +2381,7 @@ export namespace InvoiceFetchUpcomingResponse {
      * For more on the types of prices, see
      * [the core concepts documentation](/core-concepts#plan-and-price)
      */
-    price: PricesAPI.Price | null;
+    price: PricesAPI.Price;
 
     /**
      * Either the fixed fee quantity or the usage during the service period.
@@ -2212,10 +2428,15 @@ export namespace InvoiceFetchUpcomingResponse {
       amount: string;
 
       /**
-       * The price IDs that this adjustment applies to.
+       * @deprecated The price IDs that this adjustment applies to.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this adjustment to.
+       */
+      filters: Array<MonetaryUsageDiscountAdjustment.Filter>;
+
       /**
        * True for adjustments that apply to an entire invocice, false for adjustments
        * that apply to only one price.
@@ -2234,6 +2455,25 @@ export namespace InvoiceFetchUpcomingResponse {
       usage_discount: number;
     }
 
+    export namespace MonetaryUsageDiscountAdjustment {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     export interface MonetaryAmountDiscountAdjustment {
       id: string;
 
@@ -2251,10 +2491,15 @@ export namespace InvoiceFetchUpcomingResponse {
       amount_discount: string;
 
       /**
-       * The price IDs that this adjustment applies to.
+       * @deprecated The price IDs that this adjustment applies to.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this adjustment to.
+       */
+      filters: Array<MonetaryAmountDiscountAdjustment.Filter>;
+
       /**
        * True for adjustments that apply to an entire invocice, false for adjustments
        * that apply to only one price.
@@ -2267,6 +2512,25 @@ export namespace InvoiceFetchUpcomingResponse {
       reason: string | null;
     }
 
+    export namespace MonetaryAmountDiscountAdjustment {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     export interface MonetaryPercentageDiscountAdjustment {
       id: string;
 
@@ -2278,10 +2542,15 @@ export namespace InvoiceFetchUpcomingResponse {
       amount: string;
 
       /**
-       * The price IDs that this adjustment applies to.
+       * @deprecated The price IDs that this adjustment applies to.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this adjustment to.
+       */
+      filters: Array<MonetaryPercentageDiscountAdjustment.Filter>;
+
       /**
        * True for adjustments that apply to an entire invocice, false for adjustments
        * that apply to only one price.
@@ -2300,6 +2569,25 @@ export namespace InvoiceFetchUpcomingResponse {
       reason: string | null;
     }
 
+    export namespace MonetaryPercentageDiscountAdjustment {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     export interface MonetaryMinimumAdjustment {
       id: string;
 
@@ -2311,10 +2599,15 @@ export namespace InvoiceFetchUpcomingResponse {
       amount: string;
 
       /**
-       * The price IDs that this adjustment applies to.
+       * @deprecated The price IDs that this adjustment applies to.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this adjustment to.
+       */
+      filters: Array<MonetaryMinimumAdjustment.Filter>;
+
       /**
        * True for adjustments that apply to an entire invocice, false for adjustments
        * that apply to only one price.
@@ -2338,6 +2631,25 @@ export namespace InvoiceFetchUpcomingResponse {
       reason: string | null;
     }
 
+    export namespace MonetaryMinimumAdjustment {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     export interface MonetaryMaximumAdjustment {
       id: string;
 
@@ -2349,10 +2661,15 @@ export namespace InvoiceFetchUpcomingResponse {
       amount: string;
 
       /**
-       * The price IDs that this adjustment applies to.
+       * @deprecated The price IDs that this adjustment applies to.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this adjustment to.
+       */
+      filters: Array<MonetaryMaximumAdjustment.Filter>;
+
       /**
        * True for adjustments that apply to an entire invocice, false for adjustments
        * that apply to only one price.
@@ -2371,38 +2688,105 @@ export namespace InvoiceFetchUpcomingResponse {
       reason: string | null;
     }
 
+    export namespace MonetaryMaximumAdjustment {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     /**
      * @deprecated This field is deprecated in favor of `adjustments`.
      */
     export interface Maximum {
       /**
-       * List of price_ids that this maximum amount applies to. For plan/plan phase
-       * maximums, this can be a subset of prices.
+       * @deprecated List of price_ids that this maximum amount applies to. For plan/plan
+       * phase maximums, this can be a subset of prices.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this maximum to.
+       */
+      filters: Array<Maximum.Filter>;
+
       /**
        * Maximum amount applied
        */
       maximum_amount: string;
     }
 
+    export namespace Maximum {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     /**
      * @deprecated This field is deprecated in favor of `adjustments`.
      */
     export interface Minimum {
       /**
-       * List of price_ids that this minimum amount applies to. For plan/plan phase
-       * minimums, this can be a subset of prices.
+       * @deprecated List of price_ids that this minimum amount applies to. For plan/plan
+       * phase minimums, this can be a subset of prices.
        */
       applies_to_price_ids: Array<string>;
 
+      /**
+       * The filters that determine which prices to apply this minimum to.
+       */
+      filters: Array<Minimum.Filter>;
+
       /**
        * Minimum amount applied
        */
       minimum_amount: string;
     }
 
+    export namespace Minimum {
+      export interface Filter {
+        /**
+         * The property of the price to filter on.
+         */
+        field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+        /**
+         * Should prices that match the filter be included or excluded.
+         */
+        operator: 'includes' | 'excludes';
+
+        /**
+         * The IDs or values that match this filter.
+         */
+        values: Array<string>;
+      }
+    }
+
     export interface MatrixSubLineItem {
       /**
        * The total amount for this sub line item.
@@ -2520,30 +2904,78 @@ export namespace InvoiceFetchUpcomingResponse {
 
   export interface Maximum {
     /**
-     * List of price_ids that this maximum amount applies to. For plan/plan phase
-     * maximums, this can be a subset of prices.
+     * @deprecated List of price_ids that this maximum amount applies to. For plan/plan
+     * phase maximums, this can be a subset of prices.
      */
     applies_to_price_ids: Array<string>;
 
+    /**
+     * The filters that determine which prices to apply this maximum to.
+     */
+    filters: Array<Maximum.Filter>;
+
     /**
      * Maximum amount applied
      */
     maximum_amount: string;
   }
 
+  export namespace Maximum {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   export interface Minimum {
     /**
-     * List of price_ids that this minimum amount applies to. For plan/plan phase
-     * minimums, this can be a subset of prices.
+     * @deprecated List of price_ids that this minimum amount applies to. For plan/plan
+     * phase minimums, this can be a subset of prices.
      */
     applies_to_price_ids: Array<string>;
 
+    /**
+     * The filters that determine which prices to apply this minimum to.
+     */
+    filters: Array<Minimum.Filter>;
+
     /**
      * Minimum amount applied
      */
     minimum_amount: string;
   }
 
+  export namespace Minimum {
+    export interface Filter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+  }
+
   export interface PaymentAttempt {
     /**
      * The ID of the payment attempt.