orb-billing 4.72.2 → 4.73.0

package/resources/subscription-changes.d.ts

@@ -122,7 +122,8 @@ export declare namespace SubscriptionChangeRetrieveResponse {
          */
         default_invoice_memo: string | null;
         /**
-         * The discount intervals for this subscription sorted by the start_date.
+         * @deprecated The discount intervals for this subscription sorted by the
+         * start_date.
          */
         discount_intervals: Array<Subscription.AmountDiscountInterval | Subscription.PercentageDiscountInterval | Subscription.UsageDiscountInterval>;
         /**
@@ -132,7 +133,8 @@ export declare namespace SubscriptionChangeRetrieveResponse {
         fixed_fee_quantity_schedule: Array<Subscription.FixedFeeQuantitySchedule>;
         invoicing_threshold: string | null;
         /**
-         * The maximum intervals for this subscription sorted by the start_date.
+         * @deprecated The maximum intervals for this subscription sorted by the
+         * start_date.
          */
         maximum_intervals: Array<Subscription.MaximumInterval>;
         /**
@@ -143,9 +145,14 @@ export declare namespace SubscriptionChangeRetrieveResponse {
          */
         metadata: Record<string, string>;
         /**
-         * The minimum intervals for this subscription sorted by the start_date.
+         * @deprecated The minimum intervals for this subscription sorted by the
+         * start_date.
          */
         minimum_intervals: Array<Subscription.MinimumInterval>;
+        /**
+         * The name of the subscription.
+         */
+        name: string;
         /**
          * Determines the difference between the invoice issue date for subscription
          * invoices as the date that they are due. A value of `0` here represents that the
@@ -163,7 +170,7 @@ export declare namespace SubscriptionChangeRetrieveResponse {
          * subscription. You can see more about how to configure prices in the
          * [Price resource](/reference/price).
          */
-        plan: PlansAPI.Plan;
+        plan: PlansAPI.Plan | null;
         /**
          * The price intervals for this subscription.
          */
@@ -204,9 +211,13 @@ export declare namespace SubscriptionChangeRetrieveResponse {
                 id: string;
                 adjustment_type: 'usage_discount';
                 /**
-                 * 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<PlanPhaseUsageDiscountAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -226,6 +237,22 @@ export declare namespace SubscriptionChangeRetrieveResponse {
                  */
                 usage_discount: number;
             }
+            namespace PlanPhaseUsageDiscountAdjustment {
+                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 PlanPhaseAmountDiscountAdjustment {
                 id: string;
                 adjustment_type: 'amount_discount';
@@ -235,9 +262,13 @@ export declare namespace SubscriptionChangeRetrieveResponse {
                  */
                 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<PlanPhaseAmountDiscountAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -252,13 +283,33 @@ export declare namespace SubscriptionChangeRetrieveResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhaseAmountDiscountAdjustment {
+                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 PlanPhasePercentageDiscountAdjustment {
                 id: string;
                 adjustment_type: 'percentage_discount';
                 /**
-                 * 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<PlanPhasePercentageDiscountAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -278,13 +329,33 @@ export declare namespace SubscriptionChangeRetrieveResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhasePercentageDiscountAdjustment {
+                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 PlanPhaseMinimumAdjustment {
                 id: string;
                 adjustment_type: 'minimum';
                 /**
-                 * 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<PlanPhaseMinimumAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -308,13 +379,33 @@ export declare namespace SubscriptionChangeRetrieveResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhaseMinimumAdjustment {
+                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 PlanPhaseMaximumAdjustment {
                 id: string;
                 adjustment_type: 'maximum';
                 /**
-                 * 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<PlanPhaseMaximumAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -334,6 +425,22 @@ export declare namespace SubscriptionChangeRetrieveResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhaseMaximumAdjustment {
+                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 BillingCycleAnchorConfiguration {
             /**
@@ -360,10 +467,6 @@ export declare namespace SubscriptionChangeRetrieveResponse {
              * Only available if discount_type is `amount`.
              */
             amount_discount: string;
-            /**
-             * The price ids that this discount interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this discount interval applies to.
              */
@@ -373,16 +476,32 @@ export declare namespace SubscriptionChangeRetrieveResponse {
              * The end date of the discount interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this discount interval applies to.
+             */
+            filters: Array<AmountDiscountInterval.Filter>;
             /**
              * The start date of the discount interval.
              */
             start_date: string;
         }
+        namespace AmountDiscountInterval {
+            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 PercentageDiscountInterval {
-            /**
-             * The price ids that this discount interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this discount interval applies to.
              */
@@ -392,6 +511,10 @@ export declare namespace SubscriptionChangeRetrieveResponse {
              * The end date of the discount interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this discount interval applies to.
+             */
+            filters: Array<PercentageDiscountInterval.Filter>;
             /**
              * Only available if discount_type is `percentage`.This is a number between 0
              * and 1.
@@ -402,11 +525,23 @@ export declare namespace SubscriptionChangeRetrieveResponse {
              */
             start_date: string;
         }
+        namespace PercentageDiscountInterval {
+            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 UsageDiscountInterval {
-            /**
-             * The price ids that this discount interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this discount interval applies to.
              */
@@ -416,6 +551,10 @@ export declare namespace SubscriptionChangeRetrieveResponse {
              * The end date of the discount interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this discount interval applies to.
+             */
+            filters: Array<UsageDiscountInterval.Filter>;
             /**
              * The start date of the discount interval.
              */
@@ -426,6 +565,22 @@ export declare namespace SubscriptionChangeRetrieveResponse {
              */
             usage_discount: number;
         }
+        namespace UsageDiscountInterval {
+            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 FixedFeeQuantitySchedule {
             end_date: string | null;
             price_id: string;
@@ -433,10 +588,6 @@ export declare namespace SubscriptionChangeRetrieveResponse {
             start_date: string;
         }
         interface MaximumInterval {
-            /**
-             * The price ids that this maximum interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this maximum interval applies to.
              */
@@ -445,6 +596,10 @@ export declare namespace SubscriptionChangeRetrieveResponse {
              * The end date of the maximum interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this maximum interval applies to.
+             */
+            filters: Array<MaximumInterval.Filter>;
             /**
              * The maximum amount to charge in a given billing period for the price intervals
              * this transform applies to.
@@ -455,11 +610,23 @@ export declare namespace SubscriptionChangeRetrieveResponse {
              */
             start_date: string;
         }
+        namespace MaximumInterval {
+            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 MinimumInterval {
-            /**
-             * The price ids that this minimum interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this minimum interval applies to.
              */
@@ -468,6 +635,10 @@ export declare namespace SubscriptionChangeRetrieveResponse {
              * The end date of the minimum interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this minimum interval applies to.
+             */
+            filters: Array<MinimumInterval.Filter>;
             /**
              * The minimum amount to charge in a given billing period for the price intervals
              * this minimum applies to.
@@ -478,6 +649,22 @@ export declare namespace SubscriptionChangeRetrieveResponse {
              */
             start_date: string;
         }
+        namespace MinimumInterval {
+            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>;
+            }
+        }
         /**
          * A pending subscription change if one exists on this subscription.
          */
@@ -675,7 +862,8 @@ export declare namespace SubscriptionChangeApplyResponse {
          */
         default_invoice_memo: string | null;
         /**
-         * The discount intervals for this subscription sorted by the start_date.
+         * @deprecated The discount intervals for this subscription sorted by the
+         * start_date.
          */
         discount_intervals: Array<Subscription.AmountDiscountInterval | Subscription.PercentageDiscountInterval | Subscription.UsageDiscountInterval>;
         /**
@@ -685,7 +873,8 @@ export declare namespace SubscriptionChangeApplyResponse {
         fixed_fee_quantity_schedule: Array<Subscription.FixedFeeQuantitySchedule>;
         invoicing_threshold: string | null;
         /**
-         * The maximum intervals for this subscription sorted by the start_date.
+         * @deprecated The maximum intervals for this subscription sorted by the
+         * start_date.
          */
         maximum_intervals: Array<Subscription.MaximumInterval>;
         /**
@@ -696,9 +885,14 @@ export declare namespace SubscriptionChangeApplyResponse {
          */
         metadata: Record<string, string>;
         /**
-         * The minimum intervals for this subscription sorted by the start_date.
+         * @deprecated The minimum intervals for this subscription sorted by the
+         * start_date.
          */
         minimum_intervals: Array<Subscription.MinimumInterval>;
+        /**
+         * The name of the subscription.
+         */
+        name: string;
         /**
          * Determines the difference between the invoice issue date for subscription
          * invoices as the date that they are due. A value of `0` here represents that the
@@ -716,7 +910,7 @@ export declare namespace SubscriptionChangeApplyResponse {
          * subscription. You can see more about how to configure prices in the
          * [Price resource](/reference/price).
          */
-        plan: PlansAPI.Plan;
+        plan: PlansAPI.Plan | null;
         /**
          * The price intervals for this subscription.
          */
@@ -757,9 +951,13 @@ export declare namespace SubscriptionChangeApplyResponse {
                 id: string;
                 adjustment_type: 'usage_discount';
                 /**
-                 * 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<PlanPhaseUsageDiscountAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -779,6 +977,22 @@ export declare namespace SubscriptionChangeApplyResponse {
                  */
                 usage_discount: number;
             }
+            namespace PlanPhaseUsageDiscountAdjustment {
+                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 PlanPhaseAmountDiscountAdjustment {
                 id: string;
                 adjustment_type: 'amount_discount';
@@ -788,9 +1002,13 @@ export declare namespace SubscriptionChangeApplyResponse {
                  */
                 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<PlanPhaseAmountDiscountAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -805,13 +1023,33 @@ export declare namespace SubscriptionChangeApplyResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhaseAmountDiscountAdjustment {
+                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 PlanPhasePercentageDiscountAdjustment {
                 id: string;
                 adjustment_type: 'percentage_discount';
                 /**
-                 * 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<PlanPhasePercentageDiscountAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -831,13 +1069,33 @@ export declare namespace SubscriptionChangeApplyResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhasePercentageDiscountAdjustment {
+                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 PlanPhaseMinimumAdjustment {
                 id: string;
                 adjustment_type: 'minimum';
                 /**
-                 * 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<PlanPhaseMinimumAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -861,13 +1119,33 @@ export declare namespace SubscriptionChangeApplyResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhaseMinimumAdjustment {
+                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 PlanPhaseMaximumAdjustment {
                 id: string;
                 adjustment_type: 'maximum';
                 /**
-                 * 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<PlanPhaseMaximumAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -887,6 +1165,22 @@ export declare namespace SubscriptionChangeApplyResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhaseMaximumAdjustment {
+                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 BillingCycleAnchorConfiguration {
             /**
@@ -913,10 +1207,6 @@ export declare namespace SubscriptionChangeApplyResponse {
              * Only available if discount_type is `amount`.
              */
             amount_discount: string;
-            /**
-             * The price ids that this discount interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this discount interval applies to.
              */
@@ -926,16 +1216,32 @@ export declare namespace SubscriptionChangeApplyResponse {
              * The end date of the discount interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this discount interval applies to.
+             */
+            filters: Array<AmountDiscountInterval.Filter>;
             /**
              * The start date of the discount interval.
              */
             start_date: string;
         }
+        namespace AmountDiscountInterval {
+            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 PercentageDiscountInterval {
-            /**
-             * The price ids that this discount interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this discount interval applies to.
              */
@@ -945,6 +1251,10 @@ export declare namespace SubscriptionChangeApplyResponse {
              * The end date of the discount interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this discount interval applies to.
+             */
+            filters: Array<PercentageDiscountInterval.Filter>;
             /**
              * Only available if discount_type is `percentage`.This is a number between 0
              * and 1.
@@ -955,11 +1265,23 @@ export declare namespace SubscriptionChangeApplyResponse {
              */
             start_date: string;
         }
+        namespace PercentageDiscountInterval {
+            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 UsageDiscountInterval {
-            /**
-             * The price ids that this discount interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this discount interval applies to.
              */
@@ -969,6 +1291,10 @@ export declare namespace SubscriptionChangeApplyResponse {
              * The end date of the discount interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this discount interval applies to.
+             */
+            filters: Array<UsageDiscountInterval.Filter>;
             /**
              * The start date of the discount interval.
              */
@@ -979,6 +1305,22 @@ export declare namespace SubscriptionChangeApplyResponse {
              */
             usage_discount: number;
         }
+        namespace UsageDiscountInterval {
+            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 FixedFeeQuantitySchedule {
             end_date: string | null;
             price_id: string;
@@ -986,10 +1328,6 @@ export declare namespace SubscriptionChangeApplyResponse {
             start_date: string;
         }
         interface MaximumInterval {
-            /**
-             * The price ids that this maximum interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this maximum interval applies to.
              */
@@ -998,6 +1336,10 @@ export declare namespace SubscriptionChangeApplyResponse {
              * The end date of the maximum interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this maximum interval applies to.
+             */
+            filters: Array<MaximumInterval.Filter>;
             /**
              * The maximum amount to charge in a given billing period for the price intervals
              * this transform applies to.
@@ -1008,11 +1350,23 @@ export declare namespace SubscriptionChangeApplyResponse {
              */
             start_date: string;
         }
+        namespace MaximumInterval {
+            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 MinimumInterval {
-            /**
-             * The price ids that this minimum interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this minimum interval applies to.
              */
@@ -1021,6 +1375,10 @@ export declare namespace SubscriptionChangeApplyResponse {
              * The end date of the minimum interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this minimum interval applies to.
+             */
+            filters: Array<MinimumInterval.Filter>;
             /**
              * The minimum amount to charge in a given billing period for the price intervals
              * this minimum applies to.
@@ -1031,6 +1389,22 @@ export declare namespace SubscriptionChangeApplyResponse {
              */
             start_date: string;
         }
+        namespace MinimumInterval {
+            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>;
+            }
+        }
         /**
          * A pending subscription change if one exists on this subscription.
          */
@@ -1228,7 +1602,8 @@ export declare namespace SubscriptionChangeCancelResponse {
          */
         default_invoice_memo: string | null;
         /**
-         * The discount intervals for this subscription sorted by the start_date.
+         * @deprecated The discount intervals for this subscription sorted by the
+         * start_date.
          */
         discount_intervals: Array<Subscription.AmountDiscountInterval | Subscription.PercentageDiscountInterval | Subscription.UsageDiscountInterval>;
         /**
@@ -1238,7 +1613,8 @@ export declare namespace SubscriptionChangeCancelResponse {
         fixed_fee_quantity_schedule: Array<Subscription.FixedFeeQuantitySchedule>;
         invoicing_threshold: string | null;
         /**
-         * The maximum intervals for this subscription sorted by the start_date.
+         * @deprecated The maximum intervals for this subscription sorted by the
+         * start_date.
          */
         maximum_intervals: Array<Subscription.MaximumInterval>;
         /**
@@ -1249,9 +1625,14 @@ export declare namespace SubscriptionChangeCancelResponse {
          */
         metadata: Record<string, string>;
         /**
-         * The minimum intervals for this subscription sorted by the start_date.
+         * @deprecated The minimum intervals for this subscription sorted by the
+         * start_date.
          */
         minimum_intervals: Array<Subscription.MinimumInterval>;
+        /**
+         * The name of the subscription.
+         */
+        name: string;
         /**
          * Determines the difference between the invoice issue date for subscription
          * invoices as the date that they are due. A value of `0` here represents that the
@@ -1269,7 +1650,7 @@ export declare namespace SubscriptionChangeCancelResponse {
          * subscription. You can see more about how to configure prices in the
          * [Price resource](/reference/price).
          */
-        plan: PlansAPI.Plan;
+        plan: PlansAPI.Plan | null;
         /**
          * The price intervals for this subscription.
          */
@@ -1310,9 +1691,13 @@ export declare namespace SubscriptionChangeCancelResponse {
                 id: string;
                 adjustment_type: 'usage_discount';
                 /**
-                 * 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<PlanPhaseUsageDiscountAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -1332,6 +1717,22 @@ export declare namespace SubscriptionChangeCancelResponse {
                  */
                 usage_discount: number;
             }
+            namespace PlanPhaseUsageDiscountAdjustment {
+                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 PlanPhaseAmountDiscountAdjustment {
                 id: string;
                 adjustment_type: 'amount_discount';
@@ -1341,9 +1742,13 @@ export declare namespace SubscriptionChangeCancelResponse {
                  */
                 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<PlanPhaseAmountDiscountAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -1358,13 +1763,33 @@ export declare namespace SubscriptionChangeCancelResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhaseAmountDiscountAdjustment {
+                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 PlanPhasePercentageDiscountAdjustment {
                 id: string;
                 adjustment_type: 'percentage_discount';
                 /**
-                 * 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<PlanPhasePercentageDiscountAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -1384,13 +1809,33 @@ export declare namespace SubscriptionChangeCancelResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhasePercentageDiscountAdjustment {
+                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 PlanPhaseMinimumAdjustment {
                 id: string;
                 adjustment_type: 'minimum';
                 /**
-                 * 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<PlanPhaseMinimumAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -1414,13 +1859,33 @@ export declare namespace SubscriptionChangeCancelResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhaseMinimumAdjustment {
+                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 PlanPhaseMaximumAdjustment {
                 id: string;
                 adjustment_type: 'maximum';
                 /**
-                 * 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<PlanPhaseMaximumAdjustment.Filter>;
                 /**
                  * True for adjustments that apply to an entire invocice, false for adjustments
                  * that apply to only one price.
@@ -1440,6 +1905,22 @@ export declare namespace SubscriptionChangeCancelResponse {
                  */
                 reason: string | null;
             }
+            namespace PlanPhaseMaximumAdjustment {
+                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 BillingCycleAnchorConfiguration {
             /**
@@ -1466,10 +1947,6 @@ export declare namespace SubscriptionChangeCancelResponse {
              * Only available if discount_type is `amount`.
              */
             amount_discount: string;
-            /**
-             * The price ids that this discount interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this discount interval applies to.
              */
@@ -1479,16 +1956,32 @@ export declare namespace SubscriptionChangeCancelResponse {
              * The end date of the discount interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this discount interval applies to.
+             */
+            filters: Array<AmountDiscountInterval.Filter>;
             /**
              * The start date of the discount interval.
              */
             start_date: string;
         }
+        namespace AmountDiscountInterval {
+            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 PercentageDiscountInterval {
-            /**
-             * The price ids that this discount interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this discount interval applies to.
              */
@@ -1498,6 +1991,10 @@ export declare namespace SubscriptionChangeCancelResponse {
              * The end date of the discount interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this discount interval applies to.
+             */
+            filters: Array<PercentageDiscountInterval.Filter>;
             /**
              * Only available if discount_type is `percentage`.This is a number between 0
              * and 1.
@@ -1508,11 +2005,23 @@ export declare namespace SubscriptionChangeCancelResponse {
              */
             start_date: string;
         }
+        namespace PercentageDiscountInterval {
+            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 UsageDiscountInterval {
-            /**
-             * The price ids that this discount interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this discount interval applies to.
              */
@@ -1522,6 +2031,10 @@ export declare namespace SubscriptionChangeCancelResponse {
              * The end date of the discount interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this discount interval applies to.
+             */
+            filters: Array<UsageDiscountInterval.Filter>;
             /**
              * The start date of the discount interval.
              */
@@ -1532,6 +2045,22 @@ export declare namespace SubscriptionChangeCancelResponse {
              */
             usage_discount: number;
         }
+        namespace UsageDiscountInterval {
+            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 FixedFeeQuantitySchedule {
             end_date: string | null;
             price_id: string;
@@ -1539,10 +2068,6 @@ export declare namespace SubscriptionChangeCancelResponse {
             start_date: string;
         }
         interface MaximumInterval {
-            /**
-             * The price ids that this maximum interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this maximum interval applies to.
              */
@@ -1551,6 +2076,10 @@ export declare namespace SubscriptionChangeCancelResponse {
              * The end date of the maximum interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this maximum interval applies to.
+             */
+            filters: Array<MaximumInterval.Filter>;
             /**
              * The maximum amount to charge in a given billing period for the price intervals
              * this transform applies to.
@@ -1561,11 +2090,23 @@ export declare namespace SubscriptionChangeCancelResponse {
              */
             start_date: string;
         }
+        namespace MaximumInterval {
+            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 MinimumInterval {
-            /**
-             * The price ids that this minimum interval applies to.
-             */
-            applies_to_price_ids: Array<string>;
             /**
              * The price interval ids that this minimum interval applies to.
              */
@@ -1574,6 +2115,10 @@ export declare namespace SubscriptionChangeCancelResponse {
              * The end date of the minimum interval.
              */
             end_date: string | null;
+            /**
+             * The filters that determine which prices this minimum interval applies to.
+             */
+            filters: Array<MinimumInterval.Filter>;
             /**
              * The minimum amount to charge in a given billing period for the price intervals
              * this minimum applies to.
@@ -1584,6 +2129,22 @@ export declare namespace SubscriptionChangeCancelResponse {
              */
             start_date: string;
         }
+        namespace MinimumInterval {
+            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>;
+            }
+        }
         /**
          * A pending subscription change if one exists on this subscription.
          */