orb-billing 5.5.1 → 5.6.0

package/src/resources/subscriptions.ts

@@ -766,7 +766,7 @@ export class Subscriptions extends APIResource {
    * This endpoint can be used to change an existing subscription's plan. It returns
    * the serialized updated subscription object.
    *
-   * The body parameter `change_option` determines when the plan change occurrs. Orb
+   * The body parameter `change_option` determines when the plan change occurs. Orb
    * supports three options:
    *
    * - `end_of_subscription_term`: changes the plan at the end of the existing plan's
@@ -1092,196 +1092,6 @@ export interface DiscountOverride {
   usage_discount?: number | null;
 }
 
-export interface NewSubscriptionBPSPrice {
-  bps_config: Shared.BPSConfig;
-
-  /**
-   * 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;
-
-  model_type: 'bps';
-
-  /**
-   * 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 interface NewSubscriptionBulkBPSPrice {
-  bulk_bps_config: Shared.BulkBPSConfig;
-
-  /**
-   * 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;
-
-  model_type: 'bulk_bps';
-
-  /**
-   * 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 interface NewSubscriptionBulkPrice {
   bulk_config: Shared.BulkConfig;
 
@@ -2422,7 +2232,7 @@ export interface NewSubscriptionMaxGroupTieredPackagePrice {
   reference_id?: string | null;
 }
 
-export interface NewSubscriptionPackagePrice {
+export interface NewSubscriptionMinimumCompositePrice {
   /**
    * The cadence to bill for this price on.
    */
@@ -2433,15 +2243,15 @@ export interface NewSubscriptionPackagePrice {
    */
   item_id: string;
 
-  model_type: 'package';
+  minimum_config: NewSubscriptionMinimumCompositePrice.MinimumConfig;
+
+  model_type: 'minimum';
 
   /**
    * The name of the price.
    */
   name: string;
 
-  package_config: Shared.PackageConfig;
-
   /**
    * The id of the billable metric for the price. Only needed if the price is
    * usage-based.
@@ -2517,7 +2327,22 @@ export interface NewSubscriptionPackagePrice {
   reference_id?: string | null;
 }
 
-export interface NewSubscriptionPackageWithAllocationPrice {
+export namespace NewSubscriptionMinimumCompositePrice {
+  export interface MinimumConfig {
+    /**
+     * The minimum amount to apply
+     */
+    minimum_amount: string;
+
+    /**
+     * By default, subtotals from minimum composite prices are prorated based on the
+     * service period. Set to false to disable proration.
+     */
+    prorated?: boolean | null;
+  }
+}
+
+export interface NewSubscriptionPackagePrice {
   /**
    * The cadence to bill for this price on.
    */
@@ -2528,14 +2353,14 @@ export interface NewSubscriptionPackageWithAllocationPrice {
    */
   item_id: string;
 
-  model_type: 'package_with_allocation';
+  model_type: 'package';
 
   /**
    * The name of the price.
    */
   name: string;
 
-  package_with_allocation_config: { [key: string]: unknown };
+  package_config: Shared.PackageConfig;
 
   /**
    * The id of the billable metric for the price. Only needed if the price is
@@ -2612,7 +2437,7 @@ export interface NewSubscriptionPackageWithAllocationPrice {
   reference_id?: string | null;
 }
 
-export interface NewSubscriptionScalableMatrixWithTieredPricingPrice {
+export interface NewSubscriptionPackageWithAllocationPrice {
   /**
    * The cadence to bill for this price on.
    */
@@ -2623,14 +2448,14 @@ export interface NewSubscriptionScalableMatrixWithTieredPricingPrice {
    */
   item_id: string;
 
-  model_type: 'scalable_matrix_with_tiered_pricing';
+  model_type: 'package_with_allocation';
 
   /**
    * The name of the price.
    */
   name: string;
 
-  scalable_matrix_with_tiered_pricing_config: { [key: string]: unknown };
+  package_with_allocation_config: { [key: string]: unknown };
 
   /**
    * The id of the billable metric for the price. Only needed if the price is
@@ -2707,7 +2532,7 @@ export interface NewSubscriptionScalableMatrixWithTieredPricingPrice {
   reference_id?: string | null;
 }
 
-export interface NewSubscriptionScalableMatrixWithUnitPricingPrice {
+export interface NewSubscriptionScalableMatrixWithTieredPricingPrice {
   /**
    * The cadence to bill for this price on.
    */
@@ -2718,14 +2543,14 @@ export interface NewSubscriptionScalableMatrixWithUnitPricingPrice {
    */
   item_id: string;
 
-  model_type: 'scalable_matrix_with_unit_pricing';
+  model_type: 'scalable_matrix_with_tiered_pricing';
 
   /**
    * The name of the price.
    */
   name: string;
 
-  scalable_matrix_with_unit_pricing_config: { [key: string]: unknown };
+  scalable_matrix_with_tiered_pricing_config: { [key: string]: unknown };
 
   /**
    * The id of the billable metric for the price. Only needed if the price is
@@ -2802,7 +2627,7 @@ export interface NewSubscriptionScalableMatrixWithUnitPricingPrice {
   reference_id?: string | null;
 }
 
-export interface NewSubscriptionThresholdTotalAmountPrice {
+export interface NewSubscriptionScalableMatrixWithUnitPricingPrice {
   /**
    * The cadence to bill for this price on.
    */
@@ -2813,14 +2638,14 @@ export interface NewSubscriptionThresholdTotalAmountPrice {
    */
   item_id: string;
 
-  model_type: 'threshold_total_amount';
+  model_type: 'scalable_matrix_with_unit_pricing';
 
   /**
    * The name of the price.
    */
   name: string;
 
-  threshold_total_amount_config: { [key: string]: unknown };
+  scalable_matrix_with_unit_pricing_config: { [key: string]: unknown };
 
   /**
    * The id of the billable metric for the price. Only needed if the price is
@@ -2897,7 +2722,7 @@ export interface NewSubscriptionThresholdTotalAmountPrice {
   reference_id?: string | null;
 }
 
-export interface NewSubscriptionTierWithProrationPrice {
+export interface NewSubscriptionThresholdTotalAmountPrice {
   /**
    * The cadence to bill for this price on.
    */
@@ -2908,14 +2733,14 @@ export interface NewSubscriptionTierWithProrationPrice {
    */
   item_id: string;
 
-  model_type: 'tiered_with_proration';
+  model_type: 'threshold_total_amount';
 
   /**
    * The name of the price.
    */
   name: string;
 
-  tiered_with_proration_config: { [key: string]: unknown };
+  threshold_total_amount_config: { [key: string]: unknown };
 
   /**
    * The id of the billable metric for the price. Only needed if the price is
@@ -2992,7 +2817,7 @@ export interface NewSubscriptionTierWithProrationPrice {
   reference_id?: string | null;
 }
 
-export interface NewSubscriptionTieredBPSPrice {
+export interface NewSubscriptionTierWithProrationPrice {
   /**
    * The cadence to bill for this price on.
    */
@@ -3003,14 +2828,14 @@ export interface NewSubscriptionTieredBPSPrice {
    */
   item_id: string;
 
-  model_type: 'tiered_bps';
+  model_type: 'tiered_with_proration';
 
   /**
    * The name of the price.
    */
   name: string;
 
-  tiered_bps_config: Shared.TieredBPSConfig;
+  tiered_with_proration_config: { [key: string]: unknown };
 
   /**
    * The id of the billable metric for the price. Only needed if the price is
@@ -4302,9 +4127,6 @@ export namespace SubscriptionCreateParams {
       | SubscriptionsAPI.NewSubscriptionPackagePrice
       | SubscriptionsAPI.NewSubscriptionMatrixPrice
       | SubscriptionsAPI.NewSubscriptionTieredPrice
-      | SubscriptionsAPI.NewSubscriptionTieredBPSPrice
-      | SubscriptionsAPI.NewSubscriptionBPSPrice
-      | SubscriptionsAPI.NewSubscriptionBulkBPSPrice
       | SubscriptionsAPI.NewSubscriptionBulkPrice
       | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackagePrice
@@ -4326,6 +4148,8 @@ export namespace SubscriptionCreateParams {
       | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice
+      | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice
+      | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice
       | null;
 
     /**
@@ -4341,6 +4165,103 @@ export namespace SubscriptionCreateParams {
     start_date?: string | null;
   }
 
+  export namespace AddPrice {
+    export interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      grouped_with_min_max_thresholds_config: { [key: string]: unknown };
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      model_type: 'grouped_with_min_max_thresholds';
+
+      /**
+       * 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 interface RemoveAdjustment {
     /**
      * The id of the adjustment to remove on the subscription.
@@ -4424,9 +4345,6 @@ export namespace SubscriptionCreateParams {
       | SubscriptionsAPI.NewSubscriptionPackagePrice
       | SubscriptionsAPI.NewSubscriptionMatrixPrice
       | SubscriptionsAPI.NewSubscriptionTieredPrice
-      | SubscriptionsAPI.NewSubscriptionTieredBPSPrice
-      | SubscriptionsAPI.NewSubscriptionBPSPrice
-      | SubscriptionsAPI.NewSubscriptionBulkBPSPrice
       | SubscriptionsAPI.NewSubscriptionBulkPrice
       | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackagePrice
@@ -4448,6 +4366,8 @@ export namespace SubscriptionCreateParams {
       | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice
+      | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice
+      | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice
       | null;
 
     /**
@@ -4455,6 +4375,103 @@ export namespace SubscriptionCreateParams {
      */
     price_id?: string | null;
   }
+
+  export namespace ReplacePrice {
+    export interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      grouped_with_min_max_thresholds_config: { [key: string]: unknown };
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      model_type: 'grouped_with_min_max_thresholds';
+
+      /**
+       * 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 interface SubscriptionUpdateParams {
@@ -4706,9 +4723,6 @@ export namespace SubscriptionPriceIntervalsParams {
       | Shared.NewFloatingMatrixPrice
       | Shared.NewFloatingMatrixWithAllocationPrice
       | Shared.NewFloatingTieredPrice
-      | Shared.NewFloatingTieredBPSPrice
-      | Shared.NewFloatingBPSPrice
-      | Shared.NewFloatingBulkBPSPrice
       | Shared.NewFloatingBulkPrice
       | Shared.NewFloatingThresholdTotalAmountPrice
       | Shared.NewFloatingTieredPackagePrice
@@ -4729,6 +4743,8 @@ export namespace SubscriptionPriceIntervalsParams {
       | Shared.NewFloatingScalableMatrixWithUnitPricingPrice
       | Shared.NewFloatingScalableMatrixWithTieredPricingPrice
       | Shared.NewFloatingCumulativeGroupedBulkPrice
+      | Add.NewFloatingGroupedWithMinMaxThresholdsPrice
+      | Shared.NewFloatingMinimumCompositePrice
       | null;
 
     /**
@@ -4788,26 +4804,122 @@ export namespace SubscriptionPriceIntervalsParams {
        */
       quantity: number;
     }
+
+    export interface NewFloatingGroupedWithMinMaxThresholdsPrice {
+      /**
+       * 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;
+
+      grouped_with_min_max_thresholds_config: { [key: string]: unknown };
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      model_type: 'grouped_with_min_max_thresholds';
+
+      /**
+       * 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 interface AddAdjustment {
+    /**
+     * The start date of the adjustment interval. This is the date that the adjustment
+     * will start affecting prices on the subscription. The adjustment will apply to
+     * invoice dates that overlap with this `start_date`. This `start_date` is treated
+     * as inclusive for in-advance prices, and exclusive for in-arrears prices.
+     */
+    start_date: (string & {}) | Shared.BillingCycleRelativeDate;
+
     /**
      * The definition of a new adjustment to create and add to the subscription.
      */
-    adjustment:
+    adjustment?:
       | Shared.NewPercentageDiscount
       | Shared.NewUsageDiscount
       | Shared.NewAmountDiscount
       | Shared.NewMinimum
-      | Shared.NewMaximum;
+      | Shared.NewMaximum
+      | null;
 
     /**
-     * The start date of the adjustment interval. This is the date that the adjustment
-     * will start affecting prices on the subscription. The adjustment will apply to
-     * invoice dates that overlap with this `start_date`. This `start_date` is treated
-     * as inclusive for in-advance prices, and exclusive for in-arrears prices.
+     * The ID of the adjustment to add to the subscription. Adjustment IDs can be
+     * re-used from existing subscriptions or plans, but adjustments associated with
+     * coupon redemptions cannot be re-used.
      */
-    start_date: (string & {}) | Shared.BillingCycleRelativeDate;
+    adjustment_id?: string | null;
 
     /**
      * The end date of the adjustment interval. This is the date that the adjustment
@@ -5170,9 +5282,6 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | SubscriptionsAPI.NewSubscriptionPackagePrice
       | SubscriptionsAPI.NewSubscriptionMatrixPrice
       | SubscriptionsAPI.NewSubscriptionTieredPrice
-      | SubscriptionsAPI.NewSubscriptionTieredBPSPrice
-      | SubscriptionsAPI.NewSubscriptionBPSPrice
-      | SubscriptionsAPI.NewSubscriptionBulkBPSPrice
       | SubscriptionsAPI.NewSubscriptionBulkPrice
       | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackagePrice
@@ -5194,6 +5303,8 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice
+      | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice
+      | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice
       | null;
 
     /**
@@ -5209,6 +5320,103 @@ export namespace SubscriptionSchedulePlanChangeParams {
     start_date?: string | null;
   }
 
+  export namespace AddPrice {
+    export interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      grouped_with_min_max_thresholds_config: { [key: string]: unknown };
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      model_type: 'grouped_with_min_max_thresholds';
+
+      /**
+       * 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 interface RemoveAdjustment {
     /**
      * The id of the adjustment to remove on the subscription.
@@ -5292,9 +5500,6 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | SubscriptionsAPI.NewSubscriptionPackagePrice
       | SubscriptionsAPI.NewSubscriptionMatrixPrice
       | SubscriptionsAPI.NewSubscriptionTieredPrice
-      | SubscriptionsAPI.NewSubscriptionTieredBPSPrice
-      | SubscriptionsAPI.NewSubscriptionBPSPrice
-      | SubscriptionsAPI.NewSubscriptionBulkBPSPrice
       | SubscriptionsAPI.NewSubscriptionBulkPrice
       | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackagePrice
@@ -5316,6 +5521,8 @@ export namespace SubscriptionSchedulePlanChangeParams {
       | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice
       | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice
       | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice
+      | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice
+      | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice
       | null;
 
     /**
@@ -5323,6 +5530,103 @@ export namespace SubscriptionSchedulePlanChangeParams {
      */
     price_id?: string | null;
   }
+
+  export namespace ReplacePrice {
+    export interface NewSubscriptionGroupedWithMinMaxThresholdsPrice {
+      /**
+       * The cadence to bill for this price on.
+       */
+      cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+
+      grouped_with_min_max_thresholds_config: { [key: string]: unknown };
+
+      /**
+       * The id of the item the price will be associated with.
+       */
+      item_id: string;
+
+      model_type: 'grouped_with_min_max_thresholds';
+
+      /**
+       * 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 interface SubscriptionTriggerPhaseParams {
@@ -5397,8 +5701,6 @@ Subscriptions.SubscriptionFetchScheduleResponsesPage = SubscriptionFetchSchedule
 export declare namespace Subscriptions {
   export {
     type DiscountOverride as DiscountOverride,
-    type NewSubscriptionBPSPrice as NewSubscriptionBPSPrice,
-    type NewSubscriptionBulkBPSPrice as NewSubscriptionBulkBPSPrice,
     type NewSubscriptionBulkPrice as NewSubscriptionBulkPrice,
     type NewSubscriptionBulkWithProrationPrice as NewSubscriptionBulkWithProrationPrice,
     type NewSubscriptionCumulativeGroupedBulkPrice as NewSubscriptionCumulativeGroupedBulkPrice,
@@ -5411,13 +5713,13 @@ export declare namespace Subscriptions {
     type NewSubscriptionMatrixWithAllocationPrice as NewSubscriptionMatrixWithAllocationPrice,
     type NewSubscriptionMatrixWithDisplayNamePrice as NewSubscriptionMatrixWithDisplayNamePrice,
     type NewSubscriptionMaxGroupTieredPackagePrice as NewSubscriptionMaxGroupTieredPackagePrice,
+    type NewSubscriptionMinimumCompositePrice as NewSubscriptionMinimumCompositePrice,
     type NewSubscriptionPackagePrice as NewSubscriptionPackagePrice,
     type NewSubscriptionPackageWithAllocationPrice as NewSubscriptionPackageWithAllocationPrice,
     type NewSubscriptionScalableMatrixWithTieredPricingPrice as NewSubscriptionScalableMatrixWithTieredPricingPrice,
     type NewSubscriptionScalableMatrixWithUnitPricingPrice as NewSubscriptionScalableMatrixWithUnitPricingPrice,
     type NewSubscriptionThresholdTotalAmountPrice as NewSubscriptionThresholdTotalAmountPrice,
     type NewSubscriptionTierWithProrationPrice as NewSubscriptionTierWithProrationPrice,
-    type NewSubscriptionTieredBPSPrice as NewSubscriptionTieredBPSPrice,
     type NewSubscriptionTieredPackagePrice as NewSubscriptionTieredPackagePrice,
     type NewSubscriptionTieredPackageWithMinimumPrice as NewSubscriptionTieredPackageWithMinimumPrice,
     type NewSubscriptionTieredPrice as NewSubscriptionTieredPrice,