orb-billing 6.9.0 → 6.11.0

package/src/resources/subscriptions.ts

@@ -846,6 +846,17 @@ export class Subscriptions extends APIResource {
    * Note that one of `plan_id` or `external_plan_id` is required in the request body
    * for this operation.
    *
+   * ## Interaction with scheduled cancellations
+   *
+   * Scheduling a plan change also unschedules a pending cancellation, as long as the
+   * cancellation date is on or after the plan change date: Orb honors the plan
+   * change over the scheduled cancellation, and the subscription continues on the
+   * new plan. Scheduling a plan change after the subscription's end date returns a
+   * validation error instead.
+   *
+   * Any plan changes already scheduled at or after the new plan change's date are
+   * unscheduled and replaced by it.
+   *
    * ## Customize your customer's subscriptions
    *
    * Prices and adjustments in a plan can be added, removed, or replaced on the
@@ -1040,11 +1051,19 @@ export class Subscriptions extends APIResource {
    * cancellation. This operation will turn on auto-renew, ensuring that the
    * subscription does not end at the currently scheduled cancellation time.
    *
-   * Note: uncancellation is a lossy operation. Price intervals that were cut short
-   * by the cancellation are extended to infinity (original end dates are lost), and
-   * future intervals or phases scheduled after the cancellation time are permanently
-   * deleted. For complex subscriptions with phases or scheduled plan changes,
-   * consider creating a new plan change instead of uncancelling.
+   * A cancellation that has already taken effect cannot be unscheduled. This
+   * includes backdated cancellations: once the subscription's end date is in the
+   * past, this endpoint returns a validation error.
+   *
+   * Note: uncancellation is a lossy operation. Price and adjustment intervals that
+   * were cut short by the cancellation are extended to infinity (original end dates
+   * are lost), and future intervals or phases scheduled after the cancellation time
+   * are permanently deleted. For complex subscriptions with phases or scheduled plan
+   * changes, consider creating a new plan change instead of uncancelling.
+   *
+   * If the scheduled cancellation already produced invoices or credit notes (for
+   * example, a proration refund credit note for an in-advance fee), uncancelling
+   * voids and reissues them as needed to match the subscription's new state.
    *
    * @example
    * ```ts
@@ -1090,7 +1109,21 @@ export class Subscriptions extends APIResource {
 
   /**
    * This endpoint can be used to unschedule any pending plan changes on an existing
-   * subscription. When called, all upcoming plan changes will be unscheduled.
+   * subscription. When called, all upcoming plan changes will be unscheduled; it is
+   * not possible to unschedule a single plan change if multiple are scheduled.
+   *
+   * Note: unscheduling a plan change is a lossy operation, with the same semantics
+   * as
+   * [unscheduling a cancellation](/api-reference/subscription/unschedule-subscription-cancellation).
+   * Prices and adjustments on the current plan that were scheduled to end at the
+   * plan change time are extended to infinity (original end dates are lost), and
+   * anything scheduled to start after the plan change time is permanently deleted.
+   * Coupons redeemed as part of an unscheduled plan change are released and can be
+   * redeemed again.
+   *
+   * A scheduled cancellation is not affected by this operation: if the subscription
+   * has both a pending plan change and a scheduled cancellation, unscheduling the
+   * plan change leaves the cancellation in place.
    *
    * @example
    * ```ts
@@ -5188,6 +5221,7 @@ export namespace SubscriptionCreateParams {
       | SubscriptionsAPI.NewSubscriptionTieredPackagePrice
       | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice
+      | AddPrice.NewSubscriptionGroupedTieredMatrixPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice
@@ -5383,6 +5417,154 @@ export namespace SubscriptionCreateParams {
       }
     }
 
+    export interface NewSubscriptionGroupedTieredMatrixPrice {
+      /**
+       * 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.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'grouped_tiered_matrix';
+
+      /**
+       * 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.
+       */
+      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 NewSubscriptionGroupedTieredMatrixPrice {
+      /**
+       * Configuration for grouped_tiered_matrix pricing
+       */
+      export interface GroupedTieredMatrixConfig {
+        /**
+         * Per unit rate for usage whose dimension value has no configured tiers
+         */
+        default_unit_amount: string;
+
+        /**
+         * The billable metric property used to group usage before tiering
+         */
+        dimension: string;
+
+        /**
+         * Graduated tiers keyed by dimension value; usage for a value is tiered only
+         * against its own rows
+         */
+        tiers: Array<GroupedTieredMatrixConfig.Tier>;
+      }
+
+      export namespace GroupedTieredMatrixConfig {
+        /**
+         * Configuration for a single tier scoped to a dimension value
+         */
+        export interface Tier {
+          /**
+           * The dimension value this tier applies to
+           */
+          dimension_value: string;
+
+          tier_lower_bound: string;
+
+          /**
+           * Per unit amount
+           */
+          unit_amount: string;
+        }
+      }
+    }
+
     export interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
       /**
        * The cadence to bill for this price on.
@@ -6704,6 +6886,7 @@ export namespace SubscriptionCreateParams {
       | SubscriptionsAPI.NewSubscriptionTieredPackagePrice
       | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice
+      | ReplacePrice.NewSubscriptionGroupedTieredMatrixPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice
@@ -6892,26 +7075,26 @@ export namespace SubscriptionCreateParams {
       }
     }
 
-    export interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
+    export interface NewSubscriptionGroupedTieredMatrixPrice {
       /**
        * 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.
+       * Configuration for grouped_tiered_matrix pricing
        */
-      item_id: string;
+      grouped_tiered_matrix_config: NewSubscriptionGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
 
       /**
-       * Configuration for matrix_with_threshold_discounts pricing
+       * The id of the item the price will be associated with.
        */
-      matrix_with_threshold_discounts_config: NewSubscriptionMatrixWithThresholdDiscountsPrice.MatrixWithThresholdDiscountsConfig;
+      item_id: string;
 
       /**
        * The pricing model type
        */
-      model_type: 'matrix_with_threshold_discounts';
+      model_type: 'grouped_tiered_matrix';
 
       /**
        * The name of the price.
@@ -6998,70 +7181,49 @@ export namespace SubscriptionCreateParams {
       reference_id?: string | null;
     }
 
-    export namespace NewSubscriptionMatrixWithThresholdDiscountsPrice {
+    export namespace NewSubscriptionGroupedTieredMatrixPrice {
       /**
-       * Configuration for matrix_with_threshold_discounts pricing
+       * Configuration for grouped_tiered_matrix pricing
        */
-      export interface MatrixWithThresholdDiscountsConfig {
+      export interface GroupedTieredMatrixConfig {
         /**
-         * Unit price used for usage that does not match any defined matrix cell.
+         * Per unit rate for usage whose dimension value has no configured tiers
          */
         default_unit_amount: string;
 
         /**
-         * First matrix dimension key.
+         * The billable metric property used to group usage before tiering
          */
-        first_dimension: string;
+        dimension: string;
 
         /**
-         * Per-cell unit prices.
+         * Graduated tiers keyed by dimension value; usage for a value is tiered only
+         * against its own rows
          */
-        matrix_values: Array<MatrixWithThresholdDiscountsConfig.MatrixValue>;
+        tiers: Array<GroupedTieredMatrixConfig.Tier>;
+      }
 
+      export namespace GroupedTieredMatrixConfig {
         /**
-         * Optional second matrix dimension key.
+         * Configuration for a single tier scoped to a dimension value
          */
-        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 {
+        export interface Tier {
           /**
-           * Discount rate applied to spend above the threshold.
+           * The dimension value this tier applies to
            */
-          above_threshold_discount_percentage: string;
+          dimension_value: string;
 
-          /**
-           * Discount rate applied to spend at or below the threshold. Set to 0 for no
-           * baseline discount.
-           */
-          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.
        */
@@ -7073,19 +7235,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
@@ -7167,39 +7329,208 @@ 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;
 
-    export interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
-      /**
-       * The cadence to bill for this price on.
+          /**
+           * 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.
+       */
+      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;
+        }
+      }
+    }
+
+    export interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
+      /**
+       * The cadence to bill for this price on.
        */
       cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
 
@@ -8323,6 +8654,7 @@ export namespace SubscriptionPriceIntervalsParams {
       | Shared.NewFloatingTieredPackagePrice
       | Shared.NewFloatingTieredWithMinimumPrice
       | Shared.NewFloatingGroupedTieredPrice
+      | Add.NewFloatingGroupedTieredMatrixPrice
       | Shared.NewFloatingTieredPackageWithMinimumPrice
       | Shared.NewFloatingPackageWithAllocationPrice
       | Shared.NewFloatingUnitWithPercentPrice
@@ -8555,6 +8887,147 @@ export namespace SubscriptionPriceIntervalsParams {
       }
     }
 
+    export interface NewFloatingGroupedTieredMatrixPrice {
+      /**
+       * 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;
+
+      /**
+       * Configuration for grouped_tiered_matrix pricing
+       */
+      grouped_tiered_matrix_config: NewFloatingGroupedTieredMatrixPrice.GroupedTieredMatrixConfig;
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'grouped_tiered_matrix';
+
+      /**
+       * 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;
+
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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 NewFloatingGroupedTieredMatrixPrice {
+      /**
+       * Configuration for grouped_tiered_matrix pricing
+       */
+      export interface GroupedTieredMatrixConfig {
+        /**
+         * Per unit rate for usage whose dimension value has no configured tiers
+         */
+        default_unit_amount: string;
+
+        /**
+         * The billable metric property used to group usage before tiering
+         */
+        dimension: string;
+
+        /**
+         * Graduated tiers keyed by dimension value; usage for a value is tiered only
+         * against its own rows
+         */
+        tiers: Array<GroupedTieredMatrixConfig.Tier>;
+      }
+
+      export namespace GroupedTieredMatrixConfig {
+        /**
+         * Configuration for a single tier scoped to a dimension value
+         */
+        export interface Tier {
+          /**
+           * The dimension value this tier applies to
+           */
+          dimension_value: string;
+
+          tier_lower_bound: string;
+
+          /**
+           * Per unit amount
+           */
+          unit_amount: string;
+        }
+      }
+    }
+
     export interface NewFloatingMatrixWithThresholdDiscountsPrice {
       /**
        * The cadence to bill for this price on.
@@ -10098,6 +10571,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | SubscriptionsAPI.NewSubscriptionTieredPackagePrice
       | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice
+      | AddPrice.NewSubscriptionGroupedTieredMatrixPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice
@@ -10124,31 +10598,186 @@ 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;
 
-    /**
-     * 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;
-  }
+      /**
+       * 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;
 
-  export namespace AddPrice {
-    export interface NewSubscriptionBulkWithFiltersPrice {
+      /**
+       * The ID of the license type to associate with this price.
+       */
+      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
        */
-      bulk_with_filters_config: NewSubscriptionBulkWithFiltersPrice.BulkWithFiltersConfig;
+      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 NewSubscriptionGroupedTieredMatrixPrice {
       /**
        * 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.
        */
@@ -10157,7 +10786,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       /**
        * The pricing model type
        */
-      model_type: 'bulk_with_filters';
+      model_type: 'grouped_tiered_matrix';
 
       /**
        * The name of the price.
@@ -10244,51 +10873,44 @@ 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;
         }
       }
     }
@@ -11614,6 +12236,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | SubscriptionsAPI.NewSubscriptionTieredPackagePrice
       | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice
+      | ReplacePrice.NewSubscriptionGroupedTieredMatrixPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice
@@ -11802,6 +12425,154 @@ export namespace SubscriptionSchedulePlanChangeParams {
       }
     }
 
+    export interface NewSubscriptionGroupedTieredMatrixPrice {
+      /**
+       * 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.
+       */
+      item_id: string;
+
+      /**
+       * The pricing model type
+       */
+      model_type: 'grouped_tiered_matrix';
+
+      /**
+       * 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.
+       */
+      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 NewSubscriptionGroupedTieredMatrixPrice {
+      /**
+       * Configuration for grouped_tiered_matrix pricing
+       */
+      export interface GroupedTieredMatrixConfig {
+        /**
+         * Per unit rate for usage whose dimension value has no configured tiers
+         */
+        default_unit_amount: string;
+
+        /**
+         * The billable metric property used to group usage before tiering
+         */
+        dimension: string;
+
+        /**
+         * Graduated tiers keyed by dimension value; usage for a value is tiered only
+         * against its own rows
+         */
+        tiers: Array<GroupedTieredMatrixConfig.Tier>;
+      }
+
+      export namespace GroupedTieredMatrixConfig {
+        /**
+         * Configuration for a single tier scoped to a dimension value
+         */
+        export interface Tier {
+          /**
+           * The dimension value this tier applies to
+           */
+          dimension_value: string;
+
+          tier_lower_bound: string;
+
+          /**
+           * Per unit amount
+           */
+          unit_amount: string;
+        }
+      }
+    }
+
     export interface NewSubscriptionMatrixWithThresholdDiscountsPrice {
       /**
        * The cadence to bill for this price on.