orb-billing 6.14.0 → 6.16.0

package/src/resources/subscriptions.ts

@@ -5326,6 +5326,7 @@ export namespace SubscriptionCreateParams {
       | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice
       | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice
+      | AddPrice.NewSubscriptionTieredMatrixWithAllocationPrice
       | AddPrice.NewSubscriptionMatrixWithThresholdDiscountsPrice
       | AddPrice.NewSubscriptionTieredWithProrationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice
@@ -5673,6 +5674,167 @@ export namespace SubscriptionCreateParams {
       }
     }
 
+    export interface NewSubscriptionTieredMatrixWithAllocationPrice {
+      /**
+       * 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: 'tiered_matrix_with_allocation';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      tiered_matrix_with_allocation_config: NewSubscriptionTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
+
+      /**
+       * 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;
+
+      /**
+       * The ID of the license type to associate with this price. On a usage price this
+       * also marks the price as eligible to draw down from that license type's
+       * allocation; a usage price created without it is billed normally. Usage prices
+       * with a license type must use the `unit` model, and only draw down when their
+       * currency matches the allocation's.
+       */
+      license_type_id?: string | 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 NewSubscriptionTieredMatrixWithAllocationPrice {
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      export interface TieredMatrixWithAllocationConfig {
+        /**
+         * Usage allocation, pooled across all matrix cells
+         */
+        allocation: string;
+
+        /**
+         * Per unit rate for usage whose matrix cell has no configured tiers
+         */
+        default_unit_amount: string;
+
+        /**
+         * One or two event property values to evaluate matrix cells by
+         */
+        dimensions: Array<string>;
+
+        /**
+         * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
+         * own rows
+         */
+        tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
+      }
+
+      export namespace TieredMatrixWithAllocationConfig {
+        /**
+         * Configuration for a single tier scoped to one matrix cell
+         */
+        export interface Tier {
+          /**
+           * The matrix cell this tier applies to, as one or two dimension values
+           */
+          dimension_values: Array<string>;
+
+          /**
+           * Exclusive tier starting value. The tier runs up to and including the next bound
+           * configured for the same matrix cell.
+           */
+          tier_lower_bound: string;
+
+          /**
+           * Per unit amount
+           */
+          unit_amount: string;
+        }
+      }
+    }
+
     export interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
       /**
        * The cadence to bill for this price on.
@@ -7031,6 +7193,7 @@ export namespace SubscriptionCreateParams {
       | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice
       | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice
+      | ReplacePrice.NewSubscriptionTieredMatrixWithAllocationPrice
       | ReplacePrice.NewSubscriptionMatrixWithThresholdDiscountsPrice
       | ReplacePrice.NewSubscriptionTieredWithProrationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice
@@ -7371,7 +7534,7 @@ export namespace SubscriptionCreateParams {
       }
     }
 
-    export interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
+    export interface NewSubscriptionTieredMatrixWithAllocationPrice {
       /**
        * The cadence to bill for this price on.
        */
@@ -7382,21 +7545,21 @@ export namespace SubscriptionCreateParams {
        */
       item_id: string;
 
-      /**
-       * Configuration for matrix_with_threshold_discounts pricing
-       */
-      matrix_with_threshold_discounts_config: NewSubscriptionMatrixWithThresholdDiscountsPrice.MatrixWithThresholdDiscountsConfig;
-
       /**
        * The pricing model type
        */
-      model_type: 'matrix_with_threshold_discounts';
+      model_type: 'tiered_matrix_with_allocation';
 
       /**
        * The name of the price.
        */
       name: string;
 
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      tiered_matrix_with_allocation_config: NewSubscriptionTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
+
       /**
        * The id of the billable metric for the price. Only needed if the price is
        * usage-based.
@@ -7481,70 +7644,58 @@ export namespace SubscriptionCreateParams {
       reference_id?: string | null;
     }
 
-    export namespace NewSubscriptionMatrixWithThresholdDiscountsPrice {
+    export namespace NewSubscriptionTieredMatrixWithAllocationPrice {
       /**
-       * Configuration for matrix_with_threshold_discounts pricing
+       * Configuration for tiered_matrix_with_allocation pricing
        */
-      export interface MatrixWithThresholdDiscountsConfig {
+      export interface TieredMatrixWithAllocationConfig {
         /**
-         * Unit price used for usage that does not match any defined matrix cell.
+         * Usage allocation, pooled across all matrix cells
          */
-        default_unit_amount: string;
+        allocation: string;
 
         /**
-         * First matrix dimension key.
+         * Per unit rate for usage whose matrix cell has no configured tiers
          */
-        first_dimension: string;
+        default_unit_amount: string;
 
         /**
-         * Per-cell unit prices.
+         * One or two event property values to evaluate matrix cells by
          */
-        matrix_values: Array<MatrixWithThresholdDiscountsConfig.MatrixValue>;
+        dimensions: Array<string>;
 
         /**
-         * Optional second matrix dimension key.
+         * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
+         * own rows
          */
-        second_dimension?: string | null;
-
-        threshold_discount_groups?: Array<MatrixWithThresholdDiscountsConfig.ThresholdDiscountGroup>;
+        tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
       }
 
-      export namespace MatrixWithThresholdDiscountsConfig {
-        export interface MatrixValue {
-          first_dimension_value: string;
-
-          unit_amount: string;
-
-          second_dimension_value?: string | null;
-        }
-
-        export interface ThresholdDiscountGroup {
+      export namespace TieredMatrixWithAllocationConfig {
+        /**
+         * Configuration for a single tier scoped to one matrix cell
+         */
+        export interface Tier {
           /**
-           * Discount rate applied to spend above the threshold.
+           * The matrix cell this tier applies to, as one or two dimension values
            */
-          above_threshold_discount_percentage: string;
+          dimension_values: Array<string>;
 
           /**
-           * Discount rate applied to spend at or below the threshold. Set to 0 for no
-           * baseline discount.
+           * Exclusive tier starting value. The tier runs up to and including the next bound
+           * configured for the same matrix cell.
            */
-          below_threshold_discount_percentage: string;
+          tier_lower_bound: string;
 
           /**
-           * Semicolon-separated list of matrix cell coordinates targeted by this group. Each
-           * coordinate is `first,second` when the matrix has two dimensions, or just `first`
-           * for a single-dimension matrix. Example: `blue,circle;green,triangle`.
+           * Per unit amount
            */
-          cell_coordinates: string;
-
-          threshold_amount: string;
-
-          description?: string | null;
+          unit_amount: string;
         }
       }
     }
 
-    export interface NewSubscriptionTieredWithProrationPrice {
+    export interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
       /**
        * The cadence to bill for this price on.
        */
@@ -7556,19 +7707,19 @@ export namespace SubscriptionCreateParams {
       item_id: string;
 
       /**
-       * The pricing model type
+       * Configuration for matrix_with_threshold_discounts pricing
        */
-      model_type: 'tiered_with_proration';
+      matrix_with_threshold_discounts_config: NewSubscriptionMatrixWithThresholdDiscountsPrice.MatrixWithThresholdDiscountsConfig;
 
       /**
-       * The name of the price.
+       * The pricing model type
        */
-      name: string;
+      model_type: 'matrix_with_threshold_discounts';
 
       /**
-       * Configuration for tiered_with_proration pricing
+       * The name of the price.
        */
-      tiered_with_proration_config: NewSubscriptionTieredWithProrationPrice.TieredWithProrationConfig;
+      name: string;
 
       /**
        * The id of the billable metric for the price. Only needed if the price is
@@ -7654,32 +7805,205 @@ export namespace SubscriptionCreateParams {
       reference_id?: string | null;
     }
 
-    export namespace NewSubscriptionTieredWithProrationPrice {
+    export namespace NewSubscriptionMatrixWithThresholdDiscountsPrice {
       /**
-       * Configuration for tiered_with_proration pricing
+       * Configuration for matrix_with_threshold_discounts pricing
        */
-      export interface TieredWithProrationConfig {
+      export interface MatrixWithThresholdDiscountsConfig {
         /**
-         * Tiers for rating based on total usage quantities into the specified tier with
-         * proration
+         * Unit price used for usage that does not match any defined matrix cell.
          */
-        tiers: Array<TieredWithProrationConfig.Tier>;
-      }
+        default_unit_amount: string;
 
-      export namespace TieredWithProrationConfig {
         /**
-         * Configuration for a single tiered with proration tier
+         * First matrix dimension key.
          */
-        export interface Tier {
+        first_dimension: string;
+
+        /**
+         * Per-cell unit prices.
+         */
+        matrix_values: Array<MatrixWithThresholdDiscountsConfig.MatrixValue>;
+
+        /**
+         * Optional second matrix dimension key.
+         */
+        second_dimension?: string | null;
+
+        threshold_discount_groups?: Array<MatrixWithThresholdDiscountsConfig.ThresholdDiscountGroup>;
+      }
+
+      export namespace MatrixWithThresholdDiscountsConfig {
+        export interface MatrixValue {
+          first_dimension_value: string;
+
+          unit_amount: string;
+
+          second_dimension_value?: string | null;
+        }
+
+        export interface ThresholdDiscountGroup {
           /**
-           * Inclusive tier starting value
+           * Discount rate applied to spend above the threshold.
            */
-          tier_lower_bound: string;
+          above_threshold_discount_percentage: string;
 
           /**
-           * Amount per unit
+           * Discount rate applied to spend at or below the threshold. Set to 0 for no
+           * baseline discount.
            */
-          unit_amount: string;
+          below_threshold_discount_percentage: string;
+
+          /**
+           * Semicolon-separated list of matrix cell coordinates targeted by this group. Each
+           * coordinate is `first,second` when the matrix has two dimensions, or just `first`
+           * for a single-dimension matrix. Example: `blue,circle;green,triangle`.
+           */
+          cell_coordinates: string;
+
+          threshold_amount: string;
+
+          description?: string | null;
+        }
+      }
+    }
+
+    export interface NewSubscriptionTieredWithProrationPrice {
+      /**
+       * 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: '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.
+       */
+      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;
+
+      /**
+       * The ID of the license type to associate with this price. On a usage price this
+       * also marks the price as eligible to draw down from that license type's
+       * allocation; a usage price created without it is billed normally. Usage prices
+       * with a license type must use the `unit` model, and only draw down when their
+       * currency matches the allocation's.
+       */
+      license_type_id?: string | 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 NewSubscriptionTieredWithProrationPrice {
+      /**
+       * Configuration for tiered_with_proration pricing
+       */
+      export interface TieredWithProrationConfig {
+        /**
+         * Tiers for rating based on total usage quantities into the specified tier with
+         * proration
+         */
+        tiers: Array<TieredWithProrationConfig.Tier>;
+      }
+
+      export namespace TieredWithProrationConfig {
+        /**
+         * Configuration for a single tiered with proration tier
+         */
+        export interface Tier {
+          /**
+           * Inclusive tier starting value
+           */
+          tier_lower_bound: string;
+
+          /**
+           * Amount per unit
+           */
+          unit_amount: string;
         }
       }
     }
@@ -8839,6 +9163,7 @@ export namespace SubscriptionPriceIntervalsParams {
       | Shared.NewFloatingPackageWithAllocationPrice
       | Shared.NewFloatingUnitWithPercentPrice
       | Shared.NewFloatingMatrixWithAllocationPrice
+      | Add.NewFloatingTieredMatrixWithAllocationPrice
       | Add.NewFloatingMatrixWithThresholdDiscountsPrice
       | Shared.NewFloatingTieredWithProrationPrice
       | Shared.NewFloatingUnitWithProrationPrice
@@ -9216,6 +9541,160 @@ export namespace SubscriptionPriceIntervalsParams {
       }
     }
 
+    export interface NewFloatingTieredMatrixWithAllocationPrice {
+      /**
+       * 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: 'tiered_matrix_with_allocation';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      tiered_matrix_with_allocation_config: NewFloatingTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
+
+      /**
+       * 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;
+
+      /**
+       * The ID of the license type to associate with this price. On a usage price this
+       * also marks the price as eligible to draw down from that license type's
+       * allocation; a usage price created without it is billed normally. Usage prices
+       * with a license type must use the `unit` model, and only draw down when their
+       * currency matches the allocation's.
+       */
+      license_type_id?: string | 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 NewFloatingTieredMatrixWithAllocationPrice {
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      export interface TieredMatrixWithAllocationConfig {
+        /**
+         * Usage allocation, pooled across all matrix cells
+         */
+        allocation: string;
+
+        /**
+         * Per unit rate for usage whose matrix cell has no configured tiers
+         */
+        default_unit_amount: string;
+
+        /**
+         * One or two event property values to evaluate matrix cells by
+         */
+        dimensions: Array<string>;
+
+        /**
+         * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
+         * own rows
+         */
+        tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
+      }
+
+      export namespace TieredMatrixWithAllocationConfig {
+        /**
+         * Configuration for a single tier scoped to one matrix cell
+         */
+        export interface Tier {
+          /**
+           * The matrix cell this tier applies to, as one or two dimension values
+           */
+          dimension_values: Array<string>;
+
+          /**
+           * Exclusive tier starting value. The tier runs up to and including the next bound
+           * configured for the same matrix cell.
+           */
+          tier_lower_bound: string;
+
+          /**
+           * Per unit amount
+           */
+          unit_amount: string;
+        }
+      }
+    }
+
     export interface NewFloatingMatrixWithThresholdDiscountsPrice {
       /**
        * The cadence to bill for this price on.
@@ -10792,6 +11271,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice
       | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice
+      | AddPrice.NewSubscriptionTieredMatrixWithAllocationPrice
       | AddPrice.NewSubscriptionMatrixWithThresholdDiscountsPrice
       | AddPrice.NewSubscriptionTieredWithProrationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice
@@ -10814,30 +11294,189 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | AddPrice.NewSubscriptionEventOutputPrice
       | null;
 
-    /**
-     * The id of the price to add to the subscription.
-     */
-    price_id?: string | null;
+    /**
+     * The id of the price to add to the subscription.
+     */
+    price_id?: string | null;
+
+    /**
+     * The start date of the price interval. This is the date that the price will start
+     * billing on the subscription. If null, billing will start when the phase or
+     * subscription starts.
+     */
+    start_date?: string | null;
+  }
+
+  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;
+
+      /**
+       * The ID of the license type to associate with this price. On a usage price this
+       * also marks the price as eligible to draw down from that license type's
+       * allocation; a usage price created without it is billed normally. Usage prices
+       * with a license type must use the `unit` model, and only draw down when their
+       * currency matches the allocation's.
+       */
+      license_type_id?: string | 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 start date of the price interval. This is the date that the price will start
-     * billing on the subscription. If null, billing will start when the phase or
-     * subscription starts.
-     */
-    start_date?: string | null;
-  }
+          /**
+           * The lower bound for this tier
+           */
+          tier_lower_bound?: string | null;
+        }
+      }
+    }
 
-  export namespace AddPrice {
-    export interface NewSubscriptionBulkWithFiltersPrice {
+    export interface NewSubscriptionGroupedTieredMatrixPrice {
       /**
-       * Configuration for bulk_with_filters pricing
+       * The cadence to bill for this price on.
        */
-      bulk_with_filters_config: NewSubscriptionBulkWithFiltersPrice.BulkWithFiltersConfig;
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
       /**
-       * The cadence to bill for this price on.
+       * Configuration for grouped_tiered_matrix pricing
        */
-      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+      grouped_tiered_matrix_config: NewSubscriptionGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
 
       /**
        * The id of the item the price will be associated with.
@@ -10847,7 +11486,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       /**
        * The pricing model type
        */
-      model_type: 'bulk_with_filters';
+      model_type: 'grouped_tiered_matrix';
 
       /**
        * The name of the price.
@@ -10938,66 +11577,54 @@ export namespace SubscriptionSchedulePlanChangeParams {
       reference_id?: string | null;
     }
 
-    export namespace NewSubscriptionBulkWithFiltersPrice {
+    export namespace NewSubscriptionGroupedTieredMatrixPrice {
       /**
-       * Configuration for bulk_with_filters pricing
+       * Configuration for grouped_tiered_matrix pricing
        */
-      export interface BulkWithFiltersConfig {
+      export interface GroupedTieredMatrixConfig {
         /**
-         * Property filters to apply (all must match)
+         * Per unit rate for usage whose dimension value has no configured tiers
          */
-        filters: Array<BulkWithFiltersConfig.Filter>;
+        default_unit_amount: string;
 
         /**
-         * Bulk tiers for rating based on total usage volume
+         * The billable metric property used to group usage before tiering
          */
-        tiers: Array<BulkWithFiltersConfig.Tier>;
-      }
+        dimension: string;
 
-      export namespace BulkWithFiltersConfig {
         /**
-         * Configuration for a single property filter
+         * Graduated tiers keyed by dimension value; usage for a value is tiered only
+         * against its own rows
          */
-        export interface Filter {
-          /**
-           * Event property key to filter on
-           */
-          property_key: string;
-
-          /**
-           * Event property value to match
-           */
-          property_value: string;
-        }
+        tiers: Array<GroupedTieredMatrixConfig.Tier>;
+      }
 
+      export namespace GroupedTieredMatrixConfig {
         /**
-         * Configuration for a single bulk pricing tier
+         * Configuration for a single tier scoped to a dimension value
          */
         export interface Tier {
           /**
-           * Amount per unit
+           * The dimension value this tier applies to
            */
-          unit_amount: string;
+          dimension_value: string;
+
+          tier_lower_bound: string;
 
           /**
-           * The lower bound for this tier
+           * Per unit amount
            */
-          tier_lower_bound?: string | null;
+          unit_amount: string;
         }
       }
     }
 
-    export interface NewSubscriptionGroupedTieredMatrixPrice {
+    export interface NewSubscriptionTieredMatrixWithAllocationPrice {
       /**
        * The cadence to bill for this price on.
        */
       cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
-      /**
-       * Configuration for grouped_tiered_matrix pricing
-       */
-      grouped_tiered_matrix_config: NewSubscriptionGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
-
       /**
        * The id of the item the price will be associated with.
        */
@@ -11006,13 +11633,18 @@ export namespace SubscriptionSchedulePlanChangeParams {
       /**
        * The pricing model type
        */
-      model_type: 'grouped_tiered_matrix';
+      model_type: 'tiered_matrix_with_allocation';
 
       /**
        * The name of the price.
        */
       name: string;
 
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      tiered_matrix_with_allocation_config: NewSubscriptionTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
+
       /**
        * The id of the billable metric for the price. Only needed if the price is
        * usage-based.
@@ -11097,38 +11729,47 @@ export namespace SubscriptionSchedulePlanChangeParams {
       reference_id?: string | null;
     }
 
-    export namespace NewSubscriptionGroupedTieredMatrixPrice {
+    export namespace NewSubscriptionTieredMatrixWithAllocationPrice {
       /**
-       * Configuration for grouped_tiered_matrix pricing
+       * Configuration for tiered_matrix_with_allocation pricing
        */
-      export interface GroupedTieredMatrixConfig {
+      export interface TieredMatrixWithAllocationConfig {
         /**
-         * Per unit rate for usage whose dimension value has no configured tiers
+         * Usage allocation, pooled across all matrix cells
+         */
+        allocation: string;
+
+        /**
+         * Per unit rate for usage whose matrix cell has no configured tiers
          */
         default_unit_amount: string;
 
         /**
-         * The billable metric property used to group usage before tiering
+         * One or two event property values to evaluate matrix cells by
          */
-        dimension: string;
+        dimensions: Array<string>;
 
         /**
-         * Graduated tiers keyed by dimension value; usage for a value is tiered only
-         * against its own rows
+         * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
+         * own rows
          */
-        tiers: Array<GroupedTieredMatrixConfig.Tier>;
+        tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
       }
 
-      export namespace GroupedTieredMatrixConfig {
+      export namespace TieredMatrixWithAllocationConfig {
         /**
-         * Configuration for a single tier scoped to a dimension value
+         * Configuration for a single tier scoped to one matrix cell
          */
         export interface Tier {
           /**
-           * The dimension value this tier applies to
+           * The matrix cell this tier applies to, as one or two dimension values
            */
-          dimension_value: string;
+          dimension_values: Array<string>;
 
+          /**
+           * Exclusive tier starting value. The tier runs up to and including the next bound
+           * configured for the same matrix cell.
+           */
           tier_lower_bound: string;
 
           /**
@@ -12497,6 +13138,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice
       | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice
+      | ReplacePrice.NewSubscriptionTieredMatrixWithAllocationPrice
       | ReplacePrice.NewSubscriptionMatrixWithThresholdDiscountsPrice
       | ReplacePrice.NewSubscriptionTieredWithProrationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice
@@ -12837,6 +13479,167 @@ export namespace SubscriptionSchedulePlanChangeParams {
       }
     }
 
+    export interface NewSubscriptionTieredMatrixWithAllocationPrice {
+      /**
+       * 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: 'tiered_matrix_with_allocation';
+
+      /**
+       * The name of the price.
+       */
+      name: string;
+
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      tiered_matrix_with_allocation_config: NewSubscriptionTieredMatrixWithAllocationPrice.TieredMatrixWithAllocationConfig;
+
+      /**
+       * 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;
+
+      /**
+       * The ID of the license type to associate with this price. On a usage price this
+       * also marks the price as eligible to draw down from that license type's
+       * allocation; a usage price created without it is billed normally. Usage prices
+       * with a license type must use the `unit` model, and only draw down when their
+       * currency matches the allocation's.
+       */
+      license_type_id?: string | 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 NewSubscriptionTieredMatrixWithAllocationPrice {
+      /**
+       * Configuration for tiered_matrix_with_allocation pricing
+       */
+      export interface TieredMatrixWithAllocationConfig {
+        /**
+         * Usage allocation, pooled across all matrix cells
+         */
+        allocation: string;
+
+        /**
+         * Per unit rate for usage whose matrix cell has no configured tiers
+         */
+        default_unit_amount: string;
+
+        /**
+         * One or two event property values to evaluate matrix cells by
+         */
+        dimensions: Array<string>;
+
+        /**
+         * Graduated tiers keyed by matrix cell; usage in a cell is tiered only against its
+         * own rows
+         */
+        tiers: Array<TieredMatrixWithAllocationConfig.Tier>;
+      }
+
+      export namespace TieredMatrixWithAllocationConfig {
+        /**
+         * Configuration for a single tier scoped to one matrix cell
+         */
+        export interface Tier {
+          /**
+           * The matrix cell this tier applies to, as one or two dimension values
+           */
+          dimension_values: Array<string>;
+
+          /**
+           * Exclusive tier starting value. The tier runs up to and including the next bound
+           * configured for the same matrix cell.
+           */
+          tier_lower_bound: string;
+
+          /**
+           * Per unit amount
+           */
+          unit_amount: string;
+        }
+      }
+    }
+
     export interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
       /**
        * The cadence to bill for this price on.