orb-billing 4.72.3 → 4.74.0

package/resources/invoices.d.ts

@@ -627,7 +627,7 @@ export declare 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.
          */
@@ -664,9 +664,13 @@ export declare 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.
@@ -682,6 +686,22 @@ export declare namespace Invoice {
              */
             usage_discount: number;
         }
+        namespace MonetaryUsageDiscountAdjustment {
+            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>;
+            }
+        }
         interface MonetaryAmountDiscountAdjustment {
             id: string;
             adjustment_type: 'amount_discount';
@@ -695,9 +715,13 @@ export declare 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.
@@ -708,6 +732,22 @@ export declare namespace Invoice {
              */
             reason: string | null;
         }
+        namespace MonetaryAmountDiscountAdjustment {
+            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>;
+            }
+        }
         interface MonetaryPercentageDiscountAdjustment {
             id: string;
             adjustment_type: 'percentage_discount';
@@ -716,9 +756,13 @@ export declare 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.
@@ -734,6 +778,22 @@ export declare namespace Invoice {
              */
             reason: string | null;
         }
+        namespace MonetaryPercentageDiscountAdjustment {
+            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>;
+            }
+        }
         interface MonetaryMinimumAdjustment {
             id: string;
             adjustment_type: 'minimum';
@@ -742,9 +802,13 @@ export declare 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.
@@ -764,6 +828,22 @@ export declare namespace Invoice {
              */
             reason: string | null;
         }
+        namespace MonetaryMinimumAdjustment {
+            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>;
+            }
+        }
         interface MonetaryMaximumAdjustment {
             id: string;
             adjustment_type: 'maximum';
@@ -772,9 +852,13 @@ export declare 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.
@@ -790,34 +874,90 @@ export declare namespace Invoice {
              */
             reason: string | null;
         }
+        namespace MonetaryMaximumAdjustment {
+            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`.
          */
         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;
         }
+        namespace Maximum {
+            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`.
          */
         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;
         }
+        namespace Minimum {
+            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>;
+            }
+        }
         interface MatrixSubLineItem {
             /**
              * The total amount for this sub line item.
@@ -905,26 +1045,66 @@ export declare namespace Invoice {
     }
     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;
     }
+    namespace Maximum {
+        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>;
+        }
+    }
     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;
     }
+    namespace Minimum {
+        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>;
+        }
+    }
     interface PaymentAttempt {
         /**
          * The ID of the payment attempt.
@@ -1502,7 +1682,7 @@ export declare 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.
          */
@@ -1539,9 +1719,13 @@ export declare 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.
@@ -1557,6 +1741,22 @@ export declare namespace InvoiceFetchUpcomingResponse {
              */
             usage_discount: number;
         }
+        namespace MonetaryUsageDiscountAdjustment {
+            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>;
+            }
+        }
         interface MonetaryAmountDiscountAdjustment {
             id: string;
             adjustment_type: 'amount_discount';
@@ -1570,9 +1770,13 @@ export declare 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.
@@ -1583,6 +1787,22 @@ export declare namespace InvoiceFetchUpcomingResponse {
              */
             reason: string | null;
         }
+        namespace MonetaryAmountDiscountAdjustment {
+            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>;
+            }
+        }
         interface MonetaryPercentageDiscountAdjustment {
             id: string;
             adjustment_type: 'percentage_discount';
@@ -1591,9 +1811,13 @@ export declare 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.
@@ -1609,6 +1833,22 @@ export declare namespace InvoiceFetchUpcomingResponse {
              */
             reason: string | null;
         }
+        namespace MonetaryPercentageDiscountAdjustment {
+            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>;
+            }
+        }
         interface MonetaryMinimumAdjustment {
             id: string;
             adjustment_type: 'minimum';
@@ -1617,9 +1857,13 @@ export declare 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.
@@ -1639,6 +1883,22 @@ export declare namespace InvoiceFetchUpcomingResponse {
              */
             reason: string | null;
         }
+        namespace MonetaryMinimumAdjustment {
+            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>;
+            }
+        }
         interface MonetaryMaximumAdjustment {
             id: string;
             adjustment_type: 'maximum';
@@ -1647,9 +1907,13 @@ export declare 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.
@@ -1665,34 +1929,90 @@ export declare namespace InvoiceFetchUpcomingResponse {
              */
             reason: string | null;
         }
+        namespace MonetaryMaximumAdjustment {
+            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`.
          */
         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;
         }
+        namespace Maximum {
+            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`.
          */
         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;
         }
+        namespace Minimum {
+            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>;
+            }
+        }
         interface MatrixSubLineItem {
             /**
              * The total amount for this sub line item.
@@ -1780,26 +2100,66 @@ export declare namespace InvoiceFetchUpcomingResponse {
     }
     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;
     }
+    namespace Maximum {
+        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>;
+        }
+    }
     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;
     }
+    namespace Minimum {
+        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>;
+        }
+    }
     interface PaymentAttempt {
         /**
          * The ID of the payment attempt.