orb-billing 5.0.0 → 5.1.0

package/resources/shared.d.ts

@@ -319,6 +319,14 @@ export declare namespace CreditNote {
          * Any line item discounts from the invoice's line item.
          */
         discounts?: Array<LineItem.Discount>;
+        /**
+         * The end time of the service period for this credit note line item.
+         */
+        end_time_exclusive?: string | null;
+        /**
+         * The start time of the service period for this credit note line item.
+         */
+        start_time_inclusive?: string | null;
     }
     namespace LineItem {
         interface Discount {
@@ -705,7 +713,9 @@ export interface Invoice {
      * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
      * `null`.
      */
-    metadata: Record<string, string>;
+    metadata: {
+        [key: string]: string;
+    };
     minimum: Minimum | null;
     minimum_amount: string | null;
     /**
@@ -860,6 +870,9 @@ export declare namespace Invoice {
          * The number of prepaid credits applied.
          */
         credits_applied: string;
+        /**
+         * @deprecated This field is deprecated in favor of `adjustments`
+         */
         discount: Shared.Discount | null;
         /**
          * The end date of the range of time applied for this line item's price.
@@ -1137,6 +1150,11 @@ export interface MonetaryAmountDiscountAdjustment {
      * The reason for the adjustment.
      */
     reason: string | null;
+    /**
+     * The adjustment id this adjustment replaces. This adjustment will take the place
+     * of the replaced adjustment in plan version migrations.
+     */
+    replaces_adjustment_id: string | null;
 }
 export interface MonetaryMaximumAdjustment {
     id: string;
@@ -1167,6 +1185,11 @@ export interface MonetaryMaximumAdjustment {
      * The reason for the adjustment.
      */
     reason: string | null;
+    /**
+     * The adjustment id this adjustment replaces. This adjustment will take the place
+     * of the replaced adjustment in plan version migrations.
+     */
+    replaces_adjustment_id: string | null;
 }
 export interface MonetaryMinimumAdjustment {
     id: string;
@@ -1201,6 +1224,11 @@ export interface MonetaryMinimumAdjustment {
      * The reason for the adjustment.
      */
     reason: string | null;
+    /**
+     * The adjustment id this adjustment replaces. This adjustment will take the place
+     * of the replaced adjustment in plan version migrations.
+     */
+    replaces_adjustment_id: string | null;
 }
 export interface MonetaryPercentageDiscountAdjustment {
     id: string;
@@ -1231,6 +1259,11 @@ export interface MonetaryPercentageDiscountAdjustment {
      * The reason for the adjustment.
      */
     reason: string | null;
+    /**
+     * The adjustment id this adjustment replaces. This adjustment will take the place
+     * of the replaced adjustment in plan version migrations.
+     */
+    replaces_adjustment_id: string | null;
 }
 export interface MonetaryUsageDiscountAdjustment {
     id: string;
@@ -1256,6 +1289,11 @@ export interface MonetaryUsageDiscountAdjustment {
      * The reason for the adjustment.
      */
     reason: string | null;
+    /**
+     * The adjustment id this adjustment replaces. This adjustment will take the place
+     * of the replaced adjustment in plan version migrations.
+     */
+    replaces_adjustment_id: string | null;
     /**
      * The number of usage units by which to discount the price this adjustment applies
      * to in a given billing period.
@@ -1270,7 +1308,7 @@ export interface NewAllocationPrice {
     /**
      * The cadence at which to allocate the amount to the customer.
      */
-    cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+    cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual';
     /**
      * An ISO 4217 currency string or a custom pricing unit identifier in which to bill
      * this price.
@@ -1413,7 +1451,9 @@ export interface NewFloatingBPSPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingBulkBPSPrice {
     bulk_bps_config: BulkBPSConfig;
@@ -1484,7 +1524,9 @@ export interface NewFloatingBulkBPSPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingBulkPrice {
     bulk_config: BulkConfig;
@@ -1555,10 +1597,14 @@ export interface NewFloatingBulkPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingBulkWithProrationPrice {
-    bulk_with_proration_config: Record<string, unknown>;
+    bulk_with_proration_config: {
+        [key: string]: unknown;
+    };
     /**
      * The cadence to bill for this price on.
      */
@@ -1626,14 +1672,18 @@ export interface NewFloatingBulkWithProrationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingCumulativeGroupedBulkPrice {
     /**
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    cumulative_grouped_bulk_config: Record<string, unknown>;
+    cumulative_grouped_bulk_config: {
+        [key: string]: unknown;
+    };
     /**
      * An ISO 4217 currency string for which this price is billed in.
      */
@@ -1697,7 +1747,9 @@ export interface NewFloatingCumulativeGroupedBulkPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingGroupedAllocationPrice {
     /**
@@ -1708,7 +1760,9 @@ export interface NewFloatingGroupedAllocationPrice {
      * An ISO 4217 currency string for which this price is billed in.
      */
     currency: string;
-    grouped_allocation_config: Record<string, unknown>;
+    grouped_allocation_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -1768,7 +1822,9 @@ export interface NewFloatingGroupedAllocationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingGroupedTieredPackagePrice {
     /**
@@ -1779,7 +1835,9 @@ export interface NewFloatingGroupedTieredPackagePrice {
      * An ISO 4217 currency string for which this price is billed in.
      */
     currency: string;
-    grouped_tiered_package_config: Record<string, unknown>;
+    grouped_tiered_package_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -1839,7 +1897,9 @@ export interface NewFloatingGroupedTieredPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingGroupedTieredPrice {
     /**
@@ -1850,7 +1910,9 @@ export interface NewFloatingGroupedTieredPrice {
      * An ISO 4217 currency string for which this price is billed in.
      */
     currency: string;
-    grouped_tiered_config: Record<string, unknown>;
+    grouped_tiered_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -1910,7 +1972,9 @@ export interface NewFloatingGroupedTieredPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingGroupedWithMeteredMinimumPrice {
     /**
@@ -1921,7 +1985,9 @@ export interface NewFloatingGroupedWithMeteredMinimumPrice {
      * An ISO 4217 currency string for which this price is billed in.
      */
     currency: string;
-    grouped_with_metered_minimum_config: Record<string, unknown>;
+    grouped_with_metered_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -1981,7 +2047,9 @@ export interface NewFloatingGroupedWithMeteredMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingGroupedWithProratedMinimumPrice {
     /**
@@ -1992,7 +2060,9 @@ export interface NewFloatingGroupedWithProratedMinimumPrice {
      * An ISO 4217 currency string for which this price is billed in.
      */
     currency: string;
-    grouped_with_prorated_minimum_config: Record<string, unknown>;
+    grouped_with_prorated_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -2052,7 +2122,9 @@ export interface NewFloatingGroupedWithProratedMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingMatrixPrice {
     /**
@@ -2123,7 +2195,9 @@ export interface NewFloatingMatrixPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingMatrixWithAllocationPrice {
     /**
@@ -2194,7 +2268,9 @@ export interface NewFloatingMatrixWithAllocationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingMatrixWithDisplayNamePrice {
     /**
@@ -2209,7 +2285,9 @@ export interface NewFloatingMatrixWithDisplayNamePrice {
      * The id of the item the price will be associated with.
      */
     item_id: string;
-    matrix_with_display_name_config: Record<string, unknown>;
+    matrix_with_display_name_config: {
+        [key: string]: unknown;
+    };
     model_type: 'matrix_with_display_name';
     /**
      * The name of the price.
@@ -2265,7 +2343,9 @@ export interface NewFloatingMatrixWithDisplayNamePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingMaxGroupTieredPackagePrice {
     /**
@@ -2280,7 +2360,9 @@ export interface NewFloatingMaxGroupTieredPackagePrice {
      * The id of the item the price will be associated with.
      */
     item_id: string;
-    max_group_tiered_package_config: Record<string, unknown>;
+    max_group_tiered_package_config: {
+        [key: string]: unknown;
+    };
     model_type: 'max_group_tiered_package';
     /**
      * The name of the price.
@@ -2336,7 +2418,9 @@ export interface NewFloatingMaxGroupTieredPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingPackagePrice {
     /**
@@ -2407,7 +2491,9 @@ export interface NewFloatingPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingPackageWithAllocationPrice {
     /**
@@ -2427,7 +2513,9 @@ export interface NewFloatingPackageWithAllocationPrice {
      * The name of the price.
      */
     name: string;
-    package_with_allocation_config: Record<string, unknown>;
+    package_with_allocation_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2478,7 +2566,9 @@ export interface NewFloatingPackageWithAllocationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingScalableMatrixWithTieredPricingPrice {
     /**
@@ -2498,7 +2588,9 @@ export interface NewFloatingScalableMatrixWithTieredPricingPrice {
      * The name of the price.
      */
     name: string;
-    scalable_matrix_with_tiered_pricing_config: Record<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
      * usage-based.
@@ -2549,7 +2641,9 @@ export interface NewFloatingScalableMatrixWithTieredPricingPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingScalableMatrixWithUnitPricingPrice {
     /**
@@ -2569,7 +2663,9 @@ export interface NewFloatingScalableMatrixWithUnitPricingPrice {
      * The name of the price.
      */
     name: string;
-    scalable_matrix_with_unit_pricing_config: Record<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
      * usage-based.
@@ -2620,7 +2716,9 @@ export interface NewFloatingScalableMatrixWithUnitPricingPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingThresholdTotalAmountPrice {
     /**
@@ -2640,7 +2738,9 @@ export interface NewFloatingThresholdTotalAmountPrice {
      * The name of the price.
      */
     name: string;
-    threshold_total_amount_config: Record<string, unknown>;
+    threshold_total_amount_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2691,7 +2791,9 @@ export interface NewFloatingThresholdTotalAmountPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingTieredBPSPrice {
     /**
@@ -2762,7 +2864,9 @@ export interface NewFloatingTieredBPSPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingTieredPackagePrice {
     /**
@@ -2782,7 +2886,9 @@ export interface NewFloatingTieredPackagePrice {
      * The name of the price.
      */
     name: string;
-    tiered_package_config: Record<string, unknown>;
+    tiered_package_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2833,7 +2939,9 @@ export interface NewFloatingTieredPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingTieredPackageWithMinimumPrice {
     /**
@@ -2853,7 +2961,9 @@ export interface NewFloatingTieredPackageWithMinimumPrice {
      * The name of the price.
      */
     name: string;
-    tiered_package_with_minimum_config: Record<string, unknown>;
+    tiered_package_with_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -2904,7 +3014,9 @@ export interface NewFloatingTieredPackageWithMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingTieredPrice {
     /**
@@ -2975,7 +3087,9 @@ export interface NewFloatingTieredPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingTieredWithMinimumPrice {
     /**
@@ -2995,7 +3109,9 @@ export interface NewFloatingTieredWithMinimumPrice {
      * The name of the price.
      */
     name: string;
-    tiered_with_minimum_config: Record<string, unknown>;
+    tiered_with_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -3046,7 +3162,9 @@ export interface NewFloatingTieredWithMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingTieredWithProrationPrice {
     /**
@@ -3066,7 +3184,9 @@ export interface NewFloatingTieredWithProrationPrice {
      * The name of the price.
      */
     name: string;
-    tiered_with_proration_config: Record<string, unknown>;
+    tiered_with_proration_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -3117,7 +3237,9 @@ export interface NewFloatingTieredWithProrationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingUnitPrice {
     /**
@@ -3188,7 +3310,9 @@ export interface NewFloatingUnitPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingUnitWithPercentPrice {
     /**
@@ -3208,7 +3332,9 @@ export interface NewFloatingUnitWithPercentPrice {
      * The name of the price.
      */
     name: string;
-    unit_with_percent_config: Record<string, unknown>;
+    unit_with_percent_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -3259,7 +3385,9 @@ export interface NewFloatingUnitWithPercentPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewFloatingUnitWithProrationPrice {
     /**
@@ -3279,7 +3407,9 @@ export interface NewFloatingUnitWithProrationPrice {
      * The name of the price.
      */
     name: string;
-    unit_with_proration_config: Record<string, unknown>;
+    unit_with_proration_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -3330,7 +3460,9 @@ export interface NewFloatingUnitWithProrationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | null;
+    metadata?: {
+        [key: string]: string | null;
+    } | null;
 }
 export interface NewMaximum {
     adjustment_type: 'maximum';
@@ -3505,7 +3637,14 @@ export interface NewPlanBPSPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanBulkBPSPrice {
     bulk_bps_config: BulkBPSConfig;
@@ -3577,7 +3716,14 @@ export interface NewPlanBulkBPSPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanBulkPrice {
     bulk_config: BulkConfig;
@@ -3649,10 +3795,19 @@ export interface NewPlanBulkPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanBulkWithProrationPrice {
-    bulk_with_proration_config: Record<string, unknown>;
+    bulk_with_proration_config: {
+        [key: string]: unknown;
+    };
     /**
      * The cadence to bill for this price on.
      */
@@ -3721,14 +3876,23 @@ export interface NewPlanBulkWithProrationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanCumulativeGroupedBulkPrice {
     /**
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    cumulative_grouped_bulk_config: Record<string, unknown>;
+    cumulative_grouped_bulk_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -3793,14 +3957,23 @@ export interface NewPlanCumulativeGroupedBulkPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanGroupedAllocationPrice {
     /**
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    grouped_allocation_config: Record<string, unknown>;
+    grouped_allocation_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -3865,14 +4038,23 @@ export interface NewPlanGroupedAllocationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanGroupedTieredPackagePrice {
     /**
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    grouped_tiered_package_config: Record<string, unknown>;
+    grouped_tiered_package_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -3937,14 +4119,23 @@ export interface NewPlanGroupedTieredPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanGroupedTieredPrice {
     /**
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    grouped_tiered_config: Record<string, unknown>;
+    grouped_tiered_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -4009,14 +4200,23 @@ export interface NewPlanGroupedTieredPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanGroupedWithMeteredMinimumPrice {
     /**
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    grouped_with_metered_minimum_config: Record<string, unknown>;
+    grouped_with_metered_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -4081,14 +4281,23 @@ export interface NewPlanGroupedWithMeteredMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanGroupedWithProratedMinimumPrice {
     /**
      * The cadence to bill for this price on.
      */
     cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-    grouped_with_prorated_minimum_config: Record<string, unknown>;
+    grouped_with_prorated_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the item the price will be associated with.
      */
@@ -4153,7 +4362,14 @@ export interface NewPlanGroupedWithProratedMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanMatrixPrice {
     /**
@@ -4225,7 +4441,14 @@ export interface NewPlanMatrixPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanMatrixWithAllocationPrice {
     /**
@@ -4297,7 +4520,14 @@ export interface NewPlanMatrixWithAllocationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanMatrixWithDisplayNamePrice {
     /**
@@ -4308,7 +4538,9 @@ export interface NewPlanMatrixWithDisplayNamePrice {
      * The id of the item the price will be associated with.
      */
     item_id: string;
-    matrix_with_display_name_config: Record<string, unknown>;
+    matrix_with_display_name_config: {
+        [key: string]: unknown;
+    };
     model_type: 'matrix_with_display_name';
     /**
      * The name of the price.
@@ -4369,7 +4601,14 @@ export interface NewPlanMatrixWithDisplayNamePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanMaxGroupTieredPackagePrice {
     /**
@@ -4380,7 +4619,9 @@ export interface NewPlanMaxGroupTieredPackagePrice {
      * The id of the item the price will be associated with.
      */
     item_id: string;
-    max_group_tiered_package_config: Record<string, unknown>;
+    max_group_tiered_package_config: {
+        [key: string]: unknown;
+    };
     model_type: 'max_group_tiered_package';
     /**
      * The name of the price.
@@ -4441,7 +4682,14 @@ export interface NewPlanMaxGroupTieredPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanPackagePrice {
     /**
@@ -4513,7 +4761,14 @@ export interface NewPlanPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanPackageWithAllocationPrice {
     /**
@@ -4529,7 +4784,9 @@ export interface NewPlanPackageWithAllocationPrice {
      * The name of the price.
      */
     name: string;
-    package_with_allocation_config: Record<string, unknown>;
+    package_with_allocation_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -4585,7 +4842,14 @@ export interface NewPlanPackageWithAllocationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanScalableMatrixWithTieredPricingPrice {
     /**
@@ -4601,7 +4865,9 @@ export interface NewPlanScalableMatrixWithTieredPricingPrice {
      * The name of the price.
      */
     name: string;
-    scalable_matrix_with_tiered_pricing_config: Record<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
      * usage-based.
@@ -4657,7 +4923,14 @@ export interface NewPlanScalableMatrixWithTieredPricingPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanScalableMatrixWithUnitPricingPrice {
     /**
@@ -4673,7 +4946,9 @@ export interface NewPlanScalableMatrixWithUnitPricingPrice {
      * The name of the price.
      */
     name: string;
-    scalable_matrix_with_unit_pricing_config: Record<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
      * usage-based.
@@ -4729,7 +5004,14 @@ export interface NewPlanScalableMatrixWithUnitPricingPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanThresholdTotalAmountPrice {
     /**
@@ -4745,7 +5027,9 @@ export interface NewPlanThresholdTotalAmountPrice {
      * The name of the price.
      */
     name: string;
-    threshold_total_amount_config: Record<string, unknown>;
+    threshold_total_amount_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -4801,7 +5085,14 @@ export interface NewPlanThresholdTotalAmountPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanTierWithProrationPrice {
     /**
@@ -4817,7 +5108,9 @@ export interface NewPlanTierWithProrationPrice {
      * The name of the price.
      */
     name: string;
-    tiered_with_proration_config: Record<string, unknown>;
+    tiered_with_proration_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -4873,7 +5166,14 @@ export interface NewPlanTierWithProrationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanTieredBPSPrice {
     /**
@@ -4945,7 +5245,14 @@ export interface NewPlanTieredBPSPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanTieredPackagePrice {
     /**
@@ -4961,7 +5268,9 @@ export interface NewPlanTieredPackagePrice {
      * The name of the price.
      */
     name: string;
-    tiered_package_config: Record<string, unknown>;
+    tiered_package_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -5017,7 +5326,14 @@ export interface NewPlanTieredPackagePrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanTieredPackageWithMinimumPrice {
     /**
@@ -5033,7 +5349,9 @@ export interface NewPlanTieredPackageWithMinimumPrice {
      * The name of the price.
      */
     name: string;
-    tiered_package_with_minimum_config: Record<string, unknown>;
+    tiered_package_with_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -5089,7 +5407,14 @@ export interface NewPlanTieredPackageWithMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanTieredPrice {
     /**
@@ -5161,7 +5486,14 @@ export interface NewPlanTieredPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanTieredWithMinimumPrice {
     /**
@@ -5177,7 +5509,9 @@ export interface NewPlanTieredWithMinimumPrice {
      * The name of the price.
      */
     name: string;
-    tiered_with_minimum_config: Record<string, unknown>;
+    tiered_with_minimum_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -5233,7 +5567,14 @@ export interface NewPlanTieredWithMinimumPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanUnitPrice {
     /**
@@ -5305,7 +5646,14 @@ export interface NewPlanUnitPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanUnitWithPercentPrice {
     /**
@@ -5321,7 +5669,9 @@ export interface NewPlanUnitWithPercentPrice {
      * The name of the price.
      */
     name: string;
-    unit_with_percent_config: Record<string, unknown>;
+    unit_with_percent_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -5377,7 +5727,14 @@ export interface NewPlanUnitWithPercentPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewPlanUnitWithProrationPrice {
     /**
@@ -5393,7 +5750,9 @@ export interface NewPlanUnitWithProrationPrice {
      * The name of the price.
      */
     name: string;
-    unit_with_proration_config: Record<string, unknown>;
+    unit_with_proration_config: {
+        [key: string]: unknown;
+    };
     /**
      * The id of the billable metric for the price. Only needed if the price is
      * usage-based.
@@ -5449,7 +5808,14 @@ export interface NewPlanUnitWithProrationPrice {
      * by setting the value to `null`, and the entire metadata mapping can be cleared
      * by setting `metadata` to `null`.
      */
-    metadata?: Record<string, string | null> | 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 NewUsageDiscount {
     adjustment_type: 'usage_discount';
@@ -5602,6 +5968,11 @@ export interface PlanPhaseAmountDiscountAdjustment {
      * The reason for the adjustment.
      */
     reason: string | null;
+    /**
+     * The adjustment id this adjustment replaces. This adjustment will take the place
+     * of the replaced adjustment in plan version migrations.
+     */
+    replaces_adjustment_id: string | null;
 }
 export interface PlanPhaseMaximumAdjustment {
     id: string;
@@ -5632,6 +6003,11 @@ export interface PlanPhaseMaximumAdjustment {
      * The reason for the adjustment.
      */
     reason: string | null;
+    /**
+     * The adjustment id this adjustment replaces. This adjustment will take the place
+     * of the replaced adjustment in plan version migrations.
+     */
+    replaces_adjustment_id: string | null;
 }
 export interface PlanPhaseMinimumAdjustment {
     id: string;
@@ -5666,6 +6042,11 @@ export interface PlanPhaseMinimumAdjustment {
      * The reason for the adjustment.
      */
     reason: string | null;
+    /**
+     * The adjustment id this adjustment replaces. This adjustment will take the place
+     * of the replaced adjustment in plan version migrations.
+     */
+    replaces_adjustment_id: string | null;
 }
 export interface PlanPhasePercentageDiscountAdjustment {
     id: string;
@@ -5696,6 +6077,11 @@ export interface PlanPhasePercentageDiscountAdjustment {
      * The reason for the adjustment.
      */
     reason: string | null;
+    /**
+     * The adjustment id this adjustment replaces. This adjustment will take the place
+     * of the replaced adjustment in plan version migrations.
+     */
+    replaces_adjustment_id: string | null;
 }
 export interface PlanPhaseUsageDiscountAdjustment {
     id: string;
@@ -5721,6 +6107,11 @@ export interface PlanPhaseUsageDiscountAdjustment {
      * The reason for the adjustment.
      */
     reason: string | null;
+    /**
+     * The adjustment id this adjustment replaces. This adjustment will take the place
+     * of the replaced adjustment in plan version migrations.
+     */
+    replaces_adjustment_id: string | null;
     /**
      * The number of usage units by which to discount the price this adjustment applies
      * to in a given billing period.
@@ -5773,7 +6164,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -5786,6 +6179,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         unit_config: Shared.UnitConfig;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
@@ -5821,7 +6219,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -5835,6 +6235,11 @@ export declare namespace Price {
         package_config: Shared.PackageConfig;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface MatrixPrice {
@@ -5870,7 +6275,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -5883,6 +6290,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface TieredPrice {
@@ -5917,7 +6329,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -5930,6 +6344,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         tiered_config: Shared.TieredConfig;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
@@ -5965,7 +6384,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -5978,6 +6399,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         tiered_bps_config: Shared.TieredBPSConfig;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
@@ -6014,7 +6440,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6027,6 +6455,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface BulkBPSPrice {
@@ -6062,7 +6495,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6075,6 +6510,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface BulkPrice {
@@ -6110,7 +6550,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6123,6 +6565,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface ThresholdTotalAmountPrice {
@@ -6157,7 +6604,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6170,7 +6619,14 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
-        threshold_total_amount_config: Record<string, unknown>;
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        threshold_total_amount_config: {
+            [key: string]: unknown;
+        };
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface TieredPackagePrice {
@@ -6205,7 +6661,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6218,7 +6676,14 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
-        tiered_package_config: Record<string, unknown>;
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        tiered_package_config: {
+            [key: string]: unknown;
+        };
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface GroupedTieredPrice {
@@ -6237,7 +6702,9 @@ export declare namespace Price {
         discount: Shared.Discount | null;
         external_price_id: string | null;
         fixed_price_quantity: number | null;
-        grouped_tiered_config: Record<string, unknown>;
+        grouped_tiered_config: {
+            [key: string]: unknown;
+        };
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
         item: Shared.ItemSlim;
         /**
@@ -6254,7 +6721,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6267,6 +6736,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface TieredWithMinimumPrice {
@@ -6301,7 +6775,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6314,7 +6790,14 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
-        tiered_with_minimum_config: Record<string, unknown>;
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        tiered_with_minimum_config: {
+            [key: string]: unknown;
+        };
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface TieredPackageWithMinimumPrice {
@@ -6349,7 +6832,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6362,7 +6847,14 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
-        tiered_package_with_minimum_config: Record<string, unknown>;
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        tiered_package_with_minimum_config: {
+            [key: string]: unknown;
+        };
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface PackageWithAllocationPrice {
@@ -6397,7 +6889,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6408,9 +6902,16 @@ export declare namespace Price {
         minimum_amount: string | null;
         model_type: 'package_with_allocation';
         name: string;
-        package_with_allocation_config: Record<string, unknown>;
+        package_with_allocation_config: {
+            [key: string]: unknown;
+        };
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface UnitWithPercentPrice {
@@ -6445,7 +6946,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6458,7 +6961,14 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
-        unit_with_percent_config: Record<string, unknown>;
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        unit_with_percent_config: {
+            [key: string]: unknown;
+        };
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface MatrixWithAllocationPrice {
@@ -6494,7 +7004,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6507,6 +7019,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface TieredWithProrationPrice {
@@ -6541,7 +7058,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6554,7 +7073,14 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
-        tiered_with_proration_config: Record<string, unknown>;
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        tiered_with_proration_config: {
+            [key: string]: unknown;
+        };
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface UnitWithProrationPrice {
@@ -6589,7 +7115,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6602,7 +7130,14 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
-        unit_with_proration_config: Record<string, unknown>;
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        unit_with_proration_config: {
+            [key: string]: unknown;
+        };
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface GroupedAllocationPrice {
@@ -6621,7 +7156,9 @@ export declare namespace Price {
         discount: Shared.Discount | null;
         external_price_id: string | null;
         fixed_price_quantity: number | null;
-        grouped_allocation_config: Record<string, unknown>;
+        grouped_allocation_config: {
+            [key: string]: unknown;
+        };
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
         item: Shared.ItemSlim;
         /**
@@ -6638,7 +7175,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6651,6 +7190,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface GroupedWithProratedMinimumPrice {
@@ -6669,7 +7213,9 @@ export declare namespace Price {
         discount: Shared.Discount | null;
         external_price_id: string | null;
         fixed_price_quantity: number | null;
-        grouped_with_prorated_minimum_config: Record<string, unknown>;
+        grouped_with_prorated_minimum_config: {
+            [key: string]: unknown;
+        };
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
         item: Shared.ItemSlim;
         /**
@@ -6686,7 +7232,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6699,6 +7247,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface GroupedWithMeteredMinimumPrice {
@@ -6717,7 +7270,9 @@ export declare namespace Price {
         discount: Shared.Discount | null;
         external_price_id: string | null;
         fixed_price_quantity: number | null;
-        grouped_with_metered_minimum_config: Record<string, unknown>;
+        grouped_with_metered_minimum_config: {
+            [key: string]: unknown;
+        };
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
         item: Shared.ItemSlim;
         /**
@@ -6734,7 +7289,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6747,6 +7304,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface MatrixWithDisplayNamePrice {
@@ -6767,7 +7329,9 @@ export declare namespace Price {
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
         item: Shared.ItemSlim;
-        matrix_with_display_name_config: Record<string, unknown>;
+        matrix_with_display_name_config: {
+            [key: string]: unknown;
+        };
         /**
          * @deprecated
          */
@@ -6782,7 +7346,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6795,13 +7361,20 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface BulkWithProrationPrice {
         id: string;
         billable_metric: Shared.BillableMetricTiny | null;
         billing_cycle_configuration: Shared.BillingCycleConfiguration;
-        bulk_with_proration_config: Record<string, unknown>;
+        bulk_with_proration_config: {
+            [key: string]: unknown;
+        };
         cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
         conversion_rate: number | null;
         conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
@@ -6830,7 +7403,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6843,6 +7418,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface GroupedTieredPackagePrice {
@@ -6861,7 +7441,9 @@ export declare namespace Price {
         discount: Shared.Discount | null;
         external_price_id: string | null;
         fixed_price_quantity: number | null;
-        grouped_tiered_package_config: Record<string, unknown>;
+        grouped_tiered_package_config: {
+            [key: string]: unknown;
+        };
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
         item: Shared.ItemSlim;
         /**
@@ -6878,7 +7460,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6891,6 +7475,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface MaxGroupTieredPackagePrice {
@@ -6911,7 +7500,9 @@ export declare namespace Price {
         fixed_price_quantity: number | null;
         invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
         item: Shared.ItemSlim;
-        max_group_tiered_package_config: Record<string, unknown>;
+        max_group_tiered_package_config: {
+            [key: string]: unknown;
+        };
         /**
          * @deprecated
          */
@@ -6926,7 +7517,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6939,6 +7532,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface ScalableMatrixWithUnitPricingPrice {
@@ -6973,7 +7571,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -6986,7 +7586,14 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
-        scalable_matrix_with_unit_pricing_config: Record<string, unknown>;
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        scalable_matrix_with_unit_pricing_config: {
+            [key: string]: unknown;
+        };
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface ScalableMatrixWithTieredPricingPrice {
@@ -7021,7 +7628,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -7034,7 +7643,14 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
-        scalable_matrix_with_tiered_pricing_config: Record<string, unknown>;
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
+        scalable_matrix_with_tiered_pricing_config: {
+            [key: string]: unknown;
+        };
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
     interface CumulativeGroupedBulkPrice {
@@ -7046,7 +7662,9 @@ export declare namespace Price {
         conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
         created_at: string;
         credit_allocation: Shared.Allocation | null;
-        cumulative_grouped_bulk_config: Record<string, unknown>;
+        cumulative_grouped_bulk_config: {
+            [key: string]: unknown;
+        };
         currency: string;
         /**
          * @deprecated
@@ -7070,7 +7688,9 @@ export declare namespace Price {
          * `null`, and the entire metadata mapping can be cleared by setting `metadata` to
          * `null`.
          */
-        metadata: Record<string, string>;
+        metadata: {
+            [key: string]: string;
+        };
         /**
          * @deprecated
          */
@@ -7083,6 +7703,11 @@ export declare namespace Price {
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price';
+        /**
+         * The price id this price replaces. This price will take the place of the replaced
+         * price in plan version migrations.
+         */
+        replaces_price_id: string | null;
         dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
     }
 }