orb-billing 4.57.0 → 4.59.0

package/resources/subscriptions.d.ts

@@ -712,9 +712,9 @@ export declare class Subscriptions extends APIResource {
      * `plan_phase_order` key to indicate which phase the price should be added to.
      *
      * An object in the list can specify an optional `start_date` and optional
-     * `end_date`. This is equivalent to creating a price interval with the
-     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
-     * If unspecified, the start or end date of the phase or subscription will be used.
+     * `end_date`. If `start_date` is unspecified, the start of the phase / plan change
+     * time will be used. If `end_date` is unspecified, it will finish at the end of
+     * the phase / have no end time.
      *
      * An object in the list can specify an optional `minimum_amount`,
      * `maximum_amount`, or `discounts`. This will create adjustments which apply only
@@ -773,8 +773,9 @@ export declare class Subscriptions extends APIResource {
      * to.
      *
      * An object in the list can specify an optional `start_date` and optional
-     * `end_date`. If unspecified, the start or end date of the phase or subscription
-     * will be used.
+     * `end_date`. If `start_date` is unspecified, the start of the phase / plan change
+     * time will be used. If `end_date` is unspecified, it will finish at the end of
+     * the phase / have no end time.
      *
      * ### Removing adjustments
      *
@@ -6612,7 +6613,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit';
@@ -6717,7 +6718,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'package';
@@ -6827,7 +6828,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             matrix_config: NewSubscriptionMatrixPrice.MatrixConfig;
@@ -6954,7 +6955,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered';
@@ -7075,7 +7076,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_bps';
@@ -7202,7 +7203,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bps';
@@ -7311,7 +7312,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk_bps';
@@ -7433,7 +7434,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk';
@@ -7549,7 +7550,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'threshold_total_amount';
@@ -7648,7 +7649,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_package';
@@ -7747,7 +7748,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_with_minimum';
@@ -7846,7 +7847,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit_with_percent';
@@ -7945,7 +7946,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'package_with_allocation';
@@ -8044,7 +8045,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_with_proration';
@@ -8143,7 +8144,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit_with_proration';
@@ -8243,7 +8244,7 @@ export declare namespace SubscriptionCreateParams {
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             grouped_allocation_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_allocation';
@@ -8342,7 +8343,7 @@ export declare namespace SubscriptionCreateParams {
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             grouped_with_prorated_minimum_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_with_prorated_minimum';
@@ -8441,7 +8442,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk_with_proration';
@@ -8739,7 +8740,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit';
@@ -8844,7 +8845,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'package';
@@ -8954,7 +8955,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             matrix_config: NewSubscriptionMatrixPrice.MatrixConfig;
@@ -9081,7 +9082,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered';
@@ -9202,7 +9203,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_bps';
@@ -9329,7 +9330,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bps';
@@ -9438,7 +9439,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk_bps';
@@ -9560,7 +9561,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk';
@@ -9676,7 +9677,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'threshold_total_amount';
@@ -9775,7 +9776,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_package';
@@ -9874,7 +9875,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_with_minimum';
@@ -9973,7 +9974,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit_with_percent';
@@ -10072,7 +10073,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'package_with_allocation';
@@ -10171,7 +10172,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_with_proration';
@@ -10270,7 +10271,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit_with_proration';
@@ -10370,7 +10371,7 @@ export declare namespace SubscriptionCreateParams {
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             grouped_allocation_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_allocation';
@@ -10469,7 +10470,7 @@ export declare namespace SubscriptionCreateParams {
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             grouped_with_prorated_minimum_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_with_prorated_minimum';
@@ -10568,7 +10569,7 @@ export declare namespace SubscriptionCreateParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk_with_proration';
@@ -10920,7 +10921,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit';
@@ -11019,7 +11020,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'package';
@@ -11123,7 +11124,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             matrix_config: NewFloatingMatrixPrice.MatrixConfig;
@@ -11244,7 +11245,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             matrix_with_allocation_config: NewFloatingMatrixWithAllocationPrice.MatrixWithAllocationConfig;
@@ -11369,7 +11370,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered';
@@ -11484,7 +11485,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_bps';
@@ -11605,7 +11606,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bps';
@@ -11708,7 +11709,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk_bps';
@@ -11824,7 +11825,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk';
@@ -11934,7 +11935,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'threshold_total_amount';
@@ -12027,7 +12028,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_package';
@@ -12121,7 +12122,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
             currency: string;
             grouped_tiered_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_tiered';
@@ -12213,7 +12214,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             max_group_tiered_package_config: Record<string, unknown>;
@@ -12306,7 +12307,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_with_minimum';
@@ -12399,7 +12400,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'package_with_allocation';
@@ -12492,7 +12493,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_package_with_minimum';
@@ -12585,7 +12586,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit_with_percent';
@@ -12678,7 +12679,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_with_proration';
@@ -12771,7 +12772,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit_with_proration';
@@ -12865,7 +12866,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
             currency: string;
             grouped_allocation_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_allocation';
@@ -12958,7 +12959,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
             currency: string;
             grouped_with_prorated_minimum_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_with_prorated_minimum';
@@ -13051,7 +13052,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
             currency: string;
             grouped_with_metered_minimum_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_with_metered_minimum';
@@ -13143,7 +13144,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             matrix_with_display_name_config: Record<string, unknown>;
@@ -13237,7 +13238,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk_with_proration';
@@ -13330,7 +13331,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
             currency: string;
             grouped_tiered_package_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_tiered_package';
@@ -13422,7 +13423,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'scalable_matrix_with_unit_pricing';
@@ -13515,7 +13516,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'scalable_matrix_with_tiered_pricing';
@@ -13609,7 +13610,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
              */
             currency: string;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'cumulative_grouped_bulk';
@@ -14144,7 +14145,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit';
@@ -14249,7 +14250,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'package';
@@ -14359,7 +14360,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             matrix_config: NewSubscriptionMatrixPrice.MatrixConfig;
@@ -14486,7 +14487,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered';
@@ -14607,7 +14608,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_bps';
@@ -14734,7 +14735,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bps';
@@ -14843,7 +14844,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk_bps';
@@ -14965,7 +14966,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk';
@@ -15081,7 +15082,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'threshold_total_amount';
@@ -15180,7 +15181,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_package';
@@ -15279,7 +15280,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_with_minimum';
@@ -15378,7 +15379,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit_with_percent';
@@ -15477,7 +15478,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'package_with_allocation';
@@ -15576,7 +15577,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_with_proration';
@@ -15675,7 +15676,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit_with_proration';
@@ -15775,7 +15776,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             grouped_allocation_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_allocation';
@@ -15874,7 +15875,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             grouped_with_prorated_minimum_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_with_prorated_minimum';
@@ -15973,7 +15974,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk_with_proration';
@@ -16271,7 +16272,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit';
@@ -16376,7 +16377,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'package';
@@ -16486,7 +16487,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             matrix_config: NewSubscriptionMatrixPrice.MatrixConfig;
@@ -16613,7 +16614,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered';
@@ -16734,7 +16735,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_bps';
@@ -16861,7 +16862,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bps';
@@ -16970,7 +16971,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk_bps';
@@ -17092,7 +17093,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk';
@@ -17208,7 +17209,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'threshold_total_amount';
@@ -17307,7 +17308,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_package';
@@ -17406,7 +17407,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_with_minimum';
@@ -17505,7 +17506,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit_with_percent';
@@ -17604,7 +17605,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'package_with_allocation';
@@ -17703,7 +17704,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'tiered_with_proration';
@@ -17802,7 +17803,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'unit_with_proration';
@@ -17902,7 +17903,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             grouped_allocation_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_allocation';
@@ -18001,7 +18002,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             grouped_with_prorated_minimum_config: Record<string, unknown>;
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'grouped_with_prorated_minimum';
@@ -18100,7 +18101,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              */
             cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
             /**
-             * The id of the item the plan will be associated with.
+             * The id of the item the price will be associated with.
              */
             item_id: string;
             model_type: 'bulk_with_proration';