orb-billing 5.16.0 → 5.18.0

package/src/resources/subscriptions.ts

@@ -4845,6 +4845,7 @@ export namespace SubscriptionCreateParams {
       | SubscriptionsAPI.NewSubscriptionUnitPrice
       | SubscriptionsAPI.NewSubscriptionTieredPrice
       | SubscriptionsAPI.NewSubscriptionBulkPrice
+      | AddPrice.NewSubscriptionBulkWithFiltersPrice
       | SubscriptionsAPI.NewSubscriptionPackagePrice
       | SubscriptionsAPI.NewSubscriptionMatrixPrice
       | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice
@@ -4887,6 +4888,156 @@ export namespace SubscriptionCreateParams {
   }
 
   export namespace AddPrice {
+    export interface NewSubscriptionBulkWithFiltersPrice {
+      /**
+       * Configuration for bulk_with_filters pricing
+       */
+      bulk_with_filters_config: NewSubscriptionBulkWithFiltersPrice.BulkWithFiltersConfig;
+
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'bulk_with_filters';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * The id of the billable metric for the price. Only needed if the price is
+       * usage-based.
+       */
+      billable_metric_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, the price will be billed in-advance if
+       * this is true, and in-arrears if this is false.
+       */
+      billed_in_advance?: boolean | null;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+       * price is billed.
+       */
+      currency?: string | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+
+      /**
+       * An alias for the price.
+       */
+      external_price_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, this represents the quantity of units
+       * applied.
+       */
+      fixed_price_quantity?: number | null;
+
+      /**
+       * The property used to group this price on an invoice
+       */
+      invoice_grouping_key?: string | null;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
+       */
+      invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * User-specified key/value pairs for the resource. Individual keys can be removed
+       * by setting the value to `null`, and the entire metadata mapping can be cleared
+       * by setting `metadata` to `null`.
+       */
+      metadata?: { [key: string]: string | null } | null;
+
+      /**
+       * A transient ID that can be used to reference this price when adding adjustments
+       * in the same API call.
+       */
+      reference_id?: string | null;
+    }
+
+    export namespace NewSubscriptionBulkWithFiltersPrice {
+      /**
+       * Configuration for bulk_with_filters pricing
+       */
+      export interface BulkWithFiltersConfig {
+        /**
+         * Property filters to apply (all must match)
+         */
+        filters: Array<BulkWithFiltersConfig.Filter>;
+
+        /**
+         * Bulk tiers for rating based on total usage volume
+         */
+        tiers: Array<BulkWithFiltersConfig.Tier>;
+      }
+
+      export namespace BulkWithFiltersConfig {
+        /**
+         * Configuration for a single property filter
+         */
+        export interface Filter {
+          /**
+           * Event property key to filter on
+           */
+          property_key: string;
+
+          /**
+           * Event property value to match
+           */
+          property_value: string;
+        }
+
+        /**
+         * Configuration for a single bulk pricing tier
+         */
+        export interface Tier {
+          /**
+           * Amount per unit
+           */
+          unit_amount: string;
+
+          /**
+           * The lower bound for this tier
+           */
+          tier_lower_bound?: string | null;
+        }
+      }
+    }
+
     export interface NewSubscriptionTieredWithProrationPrice {
       /**
        * The cadence to bill for this price on.
@@ -5461,6 +5612,7 @@ export namespace SubscriptionCreateParams {
       | SubscriptionsAPI.NewSubscriptionUnitPrice
       | SubscriptionsAPI.NewSubscriptionTieredPrice
       | SubscriptionsAPI.NewSubscriptionBulkPrice
+      | ReplacePrice.NewSubscriptionBulkWithFiltersPrice
       | SubscriptionsAPI.NewSubscriptionPackagePrice
       | SubscriptionsAPI.NewSubscriptionMatrixPrice
       | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice
@@ -5496,7 +5648,12 @@ export namespace SubscriptionCreateParams {
   }
 
   export namespace ReplacePrice {
-    export interface NewSubscriptionTieredWithProrationPrice {
+    export interface NewSubscriptionBulkWithFiltersPrice {
+      /**
+       * Configuration for bulk_with_filters pricing
+       */
+      bulk_with_filters_config: NewSubscriptionBulkWithFiltersPrice.BulkWithFiltersConfig;
+
       /**
        * The cadence to bill for this price on.
        */
@@ -5510,18 +5667,13 @@ export namespace SubscriptionCreateParams {
       /**
        * The pricing model type
        */
-      model_type: 'tiered_with_proration';
+      model_type: 'bulk_with_filters';
 
       /**
        * The name of the price.
        */
       name: string;
 
-      /**
-       * Configuration for tiered_with_proration pricing
-       */
-      tiered_with_proration_config: NewSubscriptionTieredWithProrationPrice.TieredWithProrationConfig;
-
       /**
        * The id of the billable metric for the price. Only needed if the price is
        * usage-based.
@@ -5597,47 +5749,61 @@ export namespace SubscriptionCreateParams {
       reference_id?: string | null;
     }
 
-    export namespace NewSubscriptionTieredWithProrationPrice {
+    export namespace NewSubscriptionBulkWithFiltersPrice {
       /**
-       * Configuration for tiered_with_proration pricing
+       * Configuration for bulk_with_filters pricing
        */
-      export interface TieredWithProrationConfig {
+      export interface BulkWithFiltersConfig {
         /**
-         * Tiers for rating based on total usage quantities into the specified tier with
-         * proration
+         * Property filters to apply (all must match)
          */
-        tiers: Array<TieredWithProrationConfig.Tier>;
+        filters: Array<BulkWithFiltersConfig.Filter>;
+
+        /**
+         * Bulk tiers for rating based on total usage volume
+         */
+        tiers: Array<BulkWithFiltersConfig.Tier>;
       }
 
-      export namespace TieredWithProrationConfig {
+      export namespace BulkWithFiltersConfig {
         /**
-         * Configuration for a single tiered with proration tier
+         * Configuration for a single property filter
          */
-        export interface Tier {
+        export interface Filter {
           /**
-           * Inclusive tier starting value
+           * Event property key to filter on
            */
-          tier_lower_bound: string;
+          property_key: string;
+
+          /**
+           * Event property value to match
+           */
+          property_value: string;
+        }
 
+        /**
+         * Configuration for a single bulk pricing tier
+         */
+        export interface Tier {
           /**
            * Amount per unit
            */
           unit_amount: string;
+
+          /**
+           * The lower bound for this tier
+           */
+          tier_lower_bound?: string | null;
         }
       }
     }
 
-    export interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
+    export interface NewSubscriptionTieredWithProrationPrice {
       /**
        * The cadence to bill for this price on.
        */
       cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
-      /**
-       * Configuration for grouped_with_min_max_thresholds pricing
-       */
-      grouped_with_min_max_thresholds_config: NewSubscriptionGroupedWithMinMaxThresholdsPrice.GroupedWithMinMaxThresholdsConfig;
-
       /**
        * The id of the item the price will be associated with.
        */
@@ -5646,13 +5812,18 @@ export namespace SubscriptionCreateParams {
       /**
        * The pricing model type
        */
-      model_type: 'grouped_with_min_max_thresholds';
+      model_type: 'tiered_with_proration';
 
       /**
        * The name of the price.
        */
       name: string;
 
+      /**
+       * Configuration for tiered_with_proration pricing
+       */
+      tiered_with_proration_config: NewSubscriptionTieredWithProrationPrice.TieredWithProrationConfig;
+
       /**
        * The id of the billable metric for the price. Only needed if the price is
        * usage-based.
@@ -5728,39 +5899,47 @@ export namespace SubscriptionCreateParams {
       reference_id?: string | null;
     }
 
-    export namespace NewSubscriptionGroupedWithMinMaxThresholdsPrice {
+    export namespace NewSubscriptionTieredWithProrationPrice {
       /**
-       * Configuration for grouped_with_min_max_thresholds pricing
+       * Configuration for tiered_with_proration pricing
        */
-      export interface GroupedWithMinMaxThresholdsConfig {
-        /**
-         * The event property used to group before applying thresholds
-         */
-        grouping_key: string;
-
+      export interface TieredWithProrationConfig {
         /**
-         * The maximum amount to charge each group
+         * Tiers for rating based on total usage quantities into the specified tier with
+         * proration
          */
-        maximum_charge: string;
+        tiers: Array<TieredWithProrationConfig.Tier>;
+      }
 
+      export namespace TieredWithProrationConfig {
         /**
-         * The minimum amount to charge each group, regardless of usage
+         * Configuration for a single tiered with proration tier
          */
-        minimum_charge: string;
+        export interface Tier {
+          /**
+           * Inclusive tier starting value
+           */
+          tier_lower_bound: string;
 
-        /**
-         * The base price charged per group
-         */
-        per_unit_rate: string;
+          /**
+           * Amount per unit
+           */
+          unit_amount: string;
+        }
       }
     }
 
-    export interface NewSubscriptionPercentCompositePrice {
+    export interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
       /**
        * The cadence to bill for this price on.
        */
       cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
+      /**
+       * Configuration for grouped_with_min_max_thresholds pricing
+       */
+      grouped_with_min_max_thresholds_config: NewSubscriptionGroupedWithMinMaxThresholdsPrice.GroupedWithMinMaxThresholdsConfig;
+
       /**
        * The id of the item the price will be associated with.
        */
@@ -5769,18 +5948,13 @@ export namespace SubscriptionCreateParams {
       /**
        * The pricing model type
        */
-      model_type: 'percent';
+      model_type: 'grouped_with_min_max_thresholds';
 
       /**
        * The name of the price.
        */
       name: string;
 
-      /**
-       * Configuration for percent pricing
-       */
-      percent_config: NewSubscriptionPercentCompositePrice.PercentConfig;
-
       /**
        * The id of the billable metric for the price. Only needed if the price is
        * usage-based.
@@ -5856,28 +6030,156 @@ export namespace SubscriptionCreateParams {
       reference_id?: string | null;
     }
 
-    export namespace NewSubscriptionPercentCompositePrice {
+    export namespace NewSubscriptionGroupedWithMinMaxThresholdsPrice {
       /**
-       * Configuration for percent pricing
+       * Configuration for grouped_with_min_max_thresholds pricing
        */
-      export interface PercentConfig {
+      export interface GroupedWithMinMaxThresholdsConfig {
         /**
-         * What percent of the component subtotals to charge
+         * The event property used to group before applying thresholds
          */
-        percent: number;
+        grouping_key: string;
+
+        /**
+         * The maximum amount to charge each group
+         */
+        maximum_charge: string;
+
+        /**
+         * The minimum amount to charge each group, regardless of usage
+         */
+        minimum_charge: string;
+
+        /**
+         * The base price charged per group
+         */
+        per_unit_rate: string;
       }
     }
 
-    export interface NewSubscriptionEventOutputPrice {
+    export interface NewSubscriptionPercentCompositePrice {
       /**
        * The cadence to bill for this price on.
        */
       cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
       /**
-       * Configuration for event_output pricing
+       * The id of the item the price will be associated with.
        */
-      event_output_config: NewSubscriptionEventOutputPrice.EventOutputConfig;
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'percent';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * Configuration for percent pricing
+       */
+      percent_config: NewSubscriptionPercentCompositePrice.PercentConfig;
+
+      /**
+       * The id of the billable metric for the price. Only needed if the price is
+       * usage-based.
+       */
+      billable_metric_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, the price will be billed in-advance if
+       * this is true, and in-arrears if this is false.
+       */
+      billed_in_advance?: boolean | null;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+       * price is billed.
+       */
+      currency?: string | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+
+      /**
+       * An alias for the price.
+       */
+      external_price_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, this represents the quantity of units
+       * applied.
+       */
+      fixed_price_quantity?: number | null;
+
+      /**
+       * The property used to group this price on an invoice
+       */
+      invoice_grouping_key?: string | null;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
+       */
+      invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * User-specified key/value pairs for the resource. Individual keys can be removed
+       * by setting the value to `null`, and the entire metadata mapping can be cleared
+       * by setting `metadata` to `null`.
+       */
+      metadata?: { [key: string]: string | null } | null;
+
+      /**
+       * A transient ID that can be used to reference this price when adding adjustments
+       * in the same API call.
+       */
+      reference_id?: string | null;
+    }
+
+    export namespace NewSubscriptionPercentCompositePrice {
+      /**
+       * Configuration for percent pricing
+       */
+      export interface PercentConfig {
+        /**
+         * What percent of the component subtotals to charge
+         */
+        percent: number;
+      }
+    }
+
+    export interface NewSubscriptionEventOutputPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * Configuration for event_output pricing
+       */
+      event_output_config: NewSubscriptionEventOutputPrice.EventOutputConfig;
 
       /**
        * The id of the item the price will be associated with.
@@ -6240,6 +6542,7 @@ export namespace SubscriptionPriceIntervalsParams {
       | Shared.NewFloatingUnitPrice
       | Shared.NewFloatingTieredPrice
       | Shared.NewFloatingBulkPrice
+      | Add.NewFloatingBulkWithFiltersPrice
       | Shared.NewFloatingPackagePrice
       | Shared.NewFloatingMatrixPrice
       | Shared.NewFloatingThresholdTotalAmountPrice
@@ -6326,6 +6629,149 @@ export namespace SubscriptionPriceIntervalsParams {
       quantity: number;
     }
 
+    export interface NewFloatingBulkWithFiltersPrice {
+      /**
+       * Configuration for bulk_with_filters pricing
+       */
+      bulk_with_filters_config: NewFloatingBulkWithFiltersPrice.BulkWithFiltersConfig;
+
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * An ISO 4217 currency string for which this price is billed in.
+       */
+      currency: string;
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'bulk_with_filters';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * The id of the billable metric for the price. Only needed if the price is
+       * usage-based.
+       */
+      billable_metric_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, the price will be billed in-advance if
+       * this is true, and in-arrears if this is false.
+       */
+      billed_in_advance?: boolean | null;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+
+      /**
+       * An alias for the price.
+       */
+      external_price_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, this represents the quantity of units
+       * applied.
+       */
+      fixed_price_quantity?: number | null;
+
+      /**
+       * The property used to group this price on an invoice
+       */
+      invoice_grouping_key?: string | null;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
+       */
+      invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * User-specified key/value pairs for the resource. Individual keys can be removed
+       * by setting the value to `null`, and the entire metadata mapping can be cleared
+       * by setting `metadata` to `null`.
+       */
+      metadata?: { [key: string]: string | null } | null;
+    }
+
+    export namespace NewFloatingBulkWithFiltersPrice {
+      /**
+       * Configuration for bulk_with_filters pricing
+       */
+      export interface BulkWithFiltersConfig {
+        /**
+         * Property filters to apply (all must match)
+         */
+        filters: Array<BulkWithFiltersConfig.Filter>;
+
+        /**
+         * Bulk tiers for rating based on total usage volume
+         */
+        tiers: Array<BulkWithFiltersConfig.Tier>;
+      }
+
+      export namespace BulkWithFiltersConfig {
+        /**
+         * Configuration for a single property filter
+         */
+        export interface Filter {
+          /**
+           * Event property key to filter on
+           */
+          property_key: string;
+
+          /**
+           * Event property value to match
+           */
+          property_value: string;
+        }
+
+        /**
+         * Configuration for a single bulk pricing tier
+         */
+        export interface Tier {
+          /**
+           * Amount per unit
+           */
+          unit_amount: string;
+
+          /**
+           * The lower bound for this tier
+           */
+          tier_lower_bound?: string | null;
+        }
+      }
+    }
+
     export interface NewFloatingGroupedWithMinMaxThresholdsPrice {
       /**
        * The cadence to bill for this price on.
@@ -7053,6 +7499,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | SubscriptionsAPI.NewSubscriptionUnitPrice
       | SubscriptionsAPI.NewSubscriptionTieredPrice
       | SubscriptionsAPI.NewSubscriptionBulkPrice
+      | AddPrice.NewSubscriptionBulkWithFiltersPrice
       | SubscriptionsAPI.NewSubscriptionPackagePrice
       | SubscriptionsAPI.NewSubscriptionMatrixPrice
       | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice
@@ -7095,6 +7542,156 @@ export namespace SubscriptionSchedulePlanChangeParams {
   }
 
   export namespace AddPrice {
+    export interface NewSubscriptionBulkWithFiltersPrice {
+      /**
+       * Configuration for bulk_with_filters pricing
+       */
+      bulk_with_filters_config: NewSubscriptionBulkWithFiltersPrice.BulkWithFiltersConfig;
+
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'bulk_with_filters';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * The id of the billable metric for the price. Only needed if the price is
+       * usage-based.
+       */
+      billable_metric_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, the price will be billed in-advance if
+       * this is true, and in-arrears if this is false.
+       */
+      billed_in_advance?: boolean | null;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+       * price is billed.
+       */
+      currency?: string | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+
+      /**
+       * An alias for the price.
+       */
+      external_price_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, this represents the quantity of units
+       * applied.
+       */
+      fixed_price_quantity?: number | null;
+
+      /**
+       * The property used to group this price on an invoice
+       */
+      invoice_grouping_key?: string | null;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
+       */
+      invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * User-specified key/value pairs for the resource. Individual keys can be removed
+       * by setting the value to `null`, and the entire metadata mapping can be cleared
+       * by setting `metadata` to `null`.
+       */
+      metadata?: { [key: string]: string | null } | null;
+
+      /**
+       * A transient ID that can be used to reference this price when adding adjustments
+       * in the same API call.
+       */
+      reference_id?: string | null;
+    }
+
+    export namespace NewSubscriptionBulkWithFiltersPrice {
+      /**
+       * Configuration for bulk_with_filters pricing
+       */
+      export interface BulkWithFiltersConfig {
+        /**
+         * Property filters to apply (all must match)
+         */
+        filters: Array<BulkWithFiltersConfig.Filter>;
+
+        /**
+         * Bulk tiers for rating based on total usage volume
+         */
+        tiers: Array<BulkWithFiltersConfig.Tier>;
+      }
+
+      export namespace BulkWithFiltersConfig {
+        /**
+         * Configuration for a single property filter
+         */
+        export interface Filter {
+          /**
+           * Event property key to filter on
+           */
+          property_key: string;
+
+          /**
+           * Event property value to match
+           */
+          property_value: string;
+        }
+
+        /**
+         * Configuration for a single bulk pricing tier
+         */
+        export interface Tier {
+          /**
+           * Amount per unit
+           */
+          unit_amount: string;
+
+          /**
+           * The lower bound for this tier
+           */
+          tier_lower_bound?: string | null;
+        }
+      }
+    }
+
     export interface NewSubscriptionTieredWithProrationPrice {
       /**
        * The cadence to bill for this price on.
@@ -7669,6 +8266,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | SubscriptionsAPI.NewSubscriptionUnitPrice
       | SubscriptionsAPI.NewSubscriptionTieredPrice
       | SubscriptionsAPI.NewSubscriptionBulkPrice
+      | ReplacePrice.NewSubscriptionBulkWithFiltersPrice
       | SubscriptionsAPI.NewSubscriptionPackagePrice
       | SubscriptionsAPI.NewSubscriptionMatrixPrice
       | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice
@@ -7704,6 +8302,156 @@ export namespace SubscriptionSchedulePlanChangeParams {
   }
 
   export namespace ReplacePrice {
+    export interface NewSubscriptionBulkWithFiltersPrice {
+      /**
+       * Configuration for bulk_with_filters pricing
+       */
+      bulk_with_filters_config: NewSubscriptionBulkWithFiltersPrice.BulkWithFiltersConfig;
+
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'bulk_with_filters';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * The id of the billable metric for the price. Only needed if the price is
+       * usage-based.
+       */
+      billable_metric_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, the price will be billed in-advance if
+       * this is true, and in-arrears if this is false.
+       */
+      billed_in_advance?: boolean | null;
+
+      /**
+       * For custom cadence: specifies the duration of the billing period in days or
+       * months.
+       */
+      billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * The per unit conversion rate of the price currency to the invoicing currency.
+       */
+      conversion_rate?: number | null;
+
+      /**
+       * The configuration for the rate of the price currency to the invoicing currency.
+       */
+      conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+      /**
+       * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+       * price is billed.
+       */
+      currency?: string | null;
+
+      /**
+       * For dimensional price: specifies a price group and dimension values
+       */
+      dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+
+      /**
+       * An alias for the price.
+       */
+      external_price_id?: string | null;
+
+      /**
+       * If the Price represents a fixed cost, this represents the quantity of units
+       * applied.
+       */
+      fixed_price_quantity?: number | null;
+
+      /**
+       * The property used to group this price on an invoice
+       */
+      invoice_grouping_key?: string | null;
+
+      /**
+       * Within each billing cycle, specifies the cadence at which invoices are produced.
+       * If unspecified, a single invoice is produced per billing cycle.
+       */
+      invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+
+      /**
+       * User-specified key/value pairs for the resource. Individual keys can be removed
+       * by setting the value to `null`, and the entire metadata mapping can be cleared
+       * by setting `metadata` to `null`.
+       */
+      metadata?: { [key: string]: string | null } | null;
+
+      /**
+       * A transient ID that can be used to reference this price when adding adjustments
+       * in the same API call.
+       */
+      reference_id?: string | null;
+    }
+
+    export namespace NewSubscriptionBulkWithFiltersPrice {
+      /**
+       * Configuration for bulk_with_filters pricing
+       */
+      export interface BulkWithFiltersConfig {
+        /**
+         * Property filters to apply (all must match)
+         */
+        filters: Array<BulkWithFiltersConfig.Filter>;
+
+        /**
+         * Bulk tiers for rating based on total usage volume
+         */
+        tiers: Array<BulkWithFiltersConfig.Tier>;
+      }
+
+      export namespace BulkWithFiltersConfig {
+        /**
+         * Configuration for a single property filter
+         */
+        export interface Filter {
+          /**
+           * Event property key to filter on
+           */
+          property_key: string;
+
+          /**
+           * Event property value to match
+           */
+          property_value: string;
+        }
+
+        /**
+         * Configuration for a single bulk pricing tier
+         */
+        export interface Tier {
+          /**
+           * Amount per unit
+           */
+          unit_amount: string;
+
+          /**
+           * The lower bound for this tier
+           */
+          tier_lower_bound?: string | null;
+        }
+      }
+    }
+
     export interface NewSubscriptionTieredWithProrationPrice {
       /**
        * The cadence to bill for this price on.