orb-billing 4.24.0 → 4.25.0

package/resources/subscriptions.d.ts

@@ -2141,6 +2141,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitPrice {
             interface UnitConfig {
@@ -2241,6 +2246,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionPackagePrice {
             interface PackageConfig {
@@ -2346,6 +2356,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionMatrixPrice {
             interface MatrixConfig {
@@ -2468,6 +2483,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredPrice {
             interface TieredConfig {
@@ -2584,6 +2604,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredBpsPrice {
             interface TieredBpsConfig {
@@ -2705,6 +2730,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBpsPrice {
             interface BpsConfig {
@@ -2809,6 +2839,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkBpsPrice {
             interface BulkBpsConfig {
@@ -2926,6 +2961,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkPrice {
             interface BulkConfig {
@@ -3038,6 +3078,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionThresholdTotalAmountPrice {
             /**
@@ -3132,6 +3177,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredPackagePrice {
             /**
@@ -3226,6 +3276,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredWithMinimumPrice {
             /**
@@ -3320,6 +3375,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitWithPercentPrice {
             /**
@@ -3414,6 +3474,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionPackageWithAllocationPrice {
             /**
@@ -3508,6 +3573,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTierWithProrationPrice {
             /**
@@ -3602,6 +3672,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitWithProrationPrice {
             /**
@@ -3696,6 +3771,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionGroupedAllocationPrice {
             /**
@@ -3790,6 +3870,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionGroupedWithProratedMinimumPrice {
             /**
@@ -3884,6 +3969,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkWithProrationPrice {
             /**
@@ -5305,14 +5395,26 @@ export declare namespace SubscriptionCreateParams {
         }
     }
     interface ReplacePrice {
+        /**
+         * The id of the price on the plan to replace in the subscription.
+         */
+        replaces_price_id: string;
+        /**
+         * The external price id of the price to add to the subscription.
+         */
+        external_price_id?: string | null;
+        /**
+         * The new quantity of the price, if the price is a fixed price.
+         */
+        fixed_price_quantity?: number | null;
         /**
          * The definition of a new price to create and add to the subscription.
          */
-        price: ReplacePrice.NewSubscriptionUnitPrice | ReplacePrice.NewSubscriptionPackagePrice | ReplacePrice.NewSubscriptionMatrixPrice | ReplacePrice.NewSubscriptionTieredPrice | ReplacePrice.NewSubscriptionTieredBpsPrice | ReplacePrice.NewSubscriptionBpsPrice | ReplacePrice.NewSubscriptionBulkBpsPrice | ReplacePrice.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionThresholdTotalAmountPrice | ReplacePrice.NewSubscriptionTieredPackagePrice | ReplacePrice.NewSubscriptionTieredWithMinimumPrice | ReplacePrice.NewSubscriptionUnitWithPercentPrice | ReplacePrice.NewSubscriptionPackageWithAllocationPrice | ReplacePrice.NewSubscriptionTierWithProrationPrice | ReplacePrice.NewSubscriptionUnitWithProrationPrice | ReplacePrice.NewSubscriptionGroupedAllocationPrice | ReplacePrice.NewSubscriptionGroupedWithProratedMinimumPrice | ReplacePrice.NewSubscriptionBulkWithProrationPrice;
+        price?: ReplacePrice.NewSubscriptionUnitPrice | ReplacePrice.NewSubscriptionPackagePrice | ReplacePrice.NewSubscriptionMatrixPrice | ReplacePrice.NewSubscriptionTieredPrice | ReplacePrice.NewSubscriptionTieredBpsPrice | ReplacePrice.NewSubscriptionBpsPrice | ReplacePrice.NewSubscriptionBulkBpsPrice | ReplacePrice.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionThresholdTotalAmountPrice | ReplacePrice.NewSubscriptionTieredPackagePrice | ReplacePrice.NewSubscriptionTieredWithMinimumPrice | ReplacePrice.NewSubscriptionUnitWithPercentPrice | ReplacePrice.NewSubscriptionPackageWithAllocationPrice | ReplacePrice.NewSubscriptionTierWithProrationPrice | ReplacePrice.NewSubscriptionUnitWithProrationPrice | ReplacePrice.NewSubscriptionGroupedAllocationPrice | ReplacePrice.NewSubscriptionGroupedWithProratedMinimumPrice | ReplacePrice.NewSubscriptionBulkWithProrationPrice | null;
         /**
-         * The id of the price on the plan to replace in the subscription.
+         * The id of the price to add to the subscription.
          */
-        replaces_price_id: string;
+        price_id?: string | null;
     }
     namespace ReplacePrice {
         interface NewSubscriptionUnitPrice {
@@ -5378,6 +5480,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitPrice {
             interface UnitConfig {
@@ -5478,6 +5585,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionPackagePrice {
             interface PackageConfig {
@@ -5583,6 +5695,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionMatrixPrice {
             interface MatrixConfig {
@@ -5705,6 +5822,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredPrice {
             interface TieredConfig {
@@ -5821,6 +5943,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredBpsPrice {
             interface TieredBpsConfig {
@@ -5942,6 +6069,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBpsPrice {
             interface BpsConfig {
@@ -6046,6 +6178,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkBpsPrice {
             interface BulkBpsConfig {
@@ -6163,6 +6300,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkPrice {
             interface BulkConfig {
@@ -6275,6 +6417,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionThresholdTotalAmountPrice {
             /**
@@ -6369,6 +6516,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredPackagePrice {
             /**
@@ -6463,6 +6615,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredWithMinimumPrice {
             /**
@@ -6557,6 +6714,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitWithPercentPrice {
             /**
@@ -6651,6 +6813,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionPackageWithAllocationPrice {
             /**
@@ -6745,6 +6912,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTierWithProrationPrice {
             /**
@@ -6839,6 +7011,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitWithProrationPrice {
             /**
@@ -6933,6 +7110,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionGroupedAllocationPrice {
             /**
@@ -7027,6 +7209,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionGroupedWithProratedMinimumPrice {
             /**
@@ -7121,6 +7308,11 @@ export declare namespace SubscriptionCreateParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkWithProrationPrice {
             /**
@@ -9972,6 +10164,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitPrice {
             interface UnitConfig {
@@ -10072,6 +10269,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionPackagePrice {
             interface PackageConfig {
@@ -10177,6 +10379,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionMatrixPrice {
             interface MatrixConfig {
@@ -10299,6 +10506,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredPrice {
             interface TieredConfig {
@@ -10415,6 +10627,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredBpsPrice {
             interface TieredBpsConfig {
@@ -10536,6 +10753,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBpsPrice {
             interface BpsConfig {
@@ -10640,6 +10862,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkBpsPrice {
             interface BulkBpsConfig {
@@ -10757,6 +10984,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkPrice {
             interface BulkConfig {
@@ -10869,6 +11101,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionThresholdTotalAmountPrice {
             /**
@@ -10963,6 +11200,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredPackagePrice {
             /**
@@ -11057,6 +11299,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredWithMinimumPrice {
             /**
@@ -11151,6 +11398,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitWithPercentPrice {
             /**
@@ -11245,6 +11497,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionPackageWithAllocationPrice {
             /**
@@ -11339,6 +11596,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTierWithProrationPrice {
             /**
@@ -11433,6 +11695,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitWithProrationPrice {
             /**
@@ -11527,6 +11794,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionGroupedAllocationPrice {
             /**
@@ -11621,6 +11893,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionGroupedWithProratedMinimumPrice {
             /**
@@ -11715,6 +11992,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkWithProrationPrice {
             /**
@@ -13116,14 +13398,26 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         }
     }
     interface ReplacePrice {
+        /**
+         * The id of the price on the plan to replace in the subscription.
+         */
+        replaces_price_id: string;
+        /**
+         * The external price id of the price to add to the subscription.
+         */
+        external_price_id?: string | null;
+        /**
+         * The new quantity of the price, if the price is a fixed price.
+         */
+        fixed_price_quantity?: number | null;
         /**
          * The definition of a new price to create and add to the subscription.
          */
-        price: ReplacePrice.NewSubscriptionUnitPrice | ReplacePrice.NewSubscriptionPackagePrice | ReplacePrice.NewSubscriptionMatrixPrice | ReplacePrice.NewSubscriptionTieredPrice | ReplacePrice.NewSubscriptionTieredBpsPrice | ReplacePrice.NewSubscriptionBpsPrice | ReplacePrice.NewSubscriptionBulkBpsPrice | ReplacePrice.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionThresholdTotalAmountPrice | ReplacePrice.NewSubscriptionTieredPackagePrice | ReplacePrice.NewSubscriptionTieredWithMinimumPrice | ReplacePrice.NewSubscriptionUnitWithPercentPrice | ReplacePrice.NewSubscriptionPackageWithAllocationPrice | ReplacePrice.NewSubscriptionTierWithProrationPrice | ReplacePrice.NewSubscriptionUnitWithProrationPrice | ReplacePrice.NewSubscriptionGroupedAllocationPrice | ReplacePrice.NewSubscriptionGroupedWithProratedMinimumPrice | ReplacePrice.NewSubscriptionBulkWithProrationPrice;
+        price?: ReplacePrice.NewSubscriptionUnitPrice | ReplacePrice.NewSubscriptionPackagePrice | ReplacePrice.NewSubscriptionMatrixPrice | ReplacePrice.NewSubscriptionTieredPrice | ReplacePrice.NewSubscriptionTieredBpsPrice | ReplacePrice.NewSubscriptionBpsPrice | ReplacePrice.NewSubscriptionBulkBpsPrice | ReplacePrice.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionThresholdTotalAmountPrice | ReplacePrice.NewSubscriptionTieredPackagePrice | ReplacePrice.NewSubscriptionTieredWithMinimumPrice | ReplacePrice.NewSubscriptionUnitWithPercentPrice | ReplacePrice.NewSubscriptionPackageWithAllocationPrice | ReplacePrice.NewSubscriptionTierWithProrationPrice | ReplacePrice.NewSubscriptionUnitWithProrationPrice | ReplacePrice.NewSubscriptionGroupedAllocationPrice | ReplacePrice.NewSubscriptionGroupedWithProratedMinimumPrice | ReplacePrice.NewSubscriptionBulkWithProrationPrice | null;
         /**
-         * The id of the price on the plan to replace in the subscription.
+         * The id of the price to add to the subscription.
          */
-        replaces_price_id: string;
+        price_id?: string | null;
     }
     namespace ReplacePrice {
         interface NewSubscriptionUnitPrice {
@@ -13189,6 +13483,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitPrice {
             interface UnitConfig {
@@ -13289,6 +13588,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionPackagePrice {
             interface PackageConfig {
@@ -13394,6 +13698,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionMatrixPrice {
             interface MatrixConfig {
@@ -13516,6 +13825,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredPrice {
             interface TieredConfig {
@@ -13632,6 +13946,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredBpsPrice {
             interface TieredBpsConfig {
@@ -13753,6 +14072,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBpsPrice {
             interface BpsConfig {
@@ -13857,6 +14181,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkBpsPrice {
             interface BulkBpsConfig {
@@ -13974,6 +14303,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkPrice {
             interface BulkConfig {
@@ -14086,6 +14420,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionThresholdTotalAmountPrice {
             /**
@@ -14180,6 +14519,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredPackagePrice {
             /**
@@ -14274,6 +14618,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTieredWithMinimumPrice {
             /**
@@ -14368,6 +14717,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitWithPercentPrice {
             /**
@@ -14462,6 +14816,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionPackageWithAllocationPrice {
             /**
@@ -14556,6 +14915,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionTierWithProrationPrice {
             /**
@@ -14650,6 +15014,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionUnitWithProrationPrice {
             /**
@@ -14744,6 +15113,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionGroupedAllocationPrice {
             /**
@@ -14838,6 +15212,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionGroupedWithProratedMinimumPrice {
             /**
@@ -14932,6 +15311,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * by setting `metadata` to `null`.
              */
             metadata?: Record<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;
         }
         namespace NewSubscriptionBulkWithProrationPrice {
             /**