orb-billing 4.58.0 → 4.60.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
      *
@@ -6422,6 +6423,15 @@ export interface SubscriptionCreateParams {
      * skipped.
      */
     trial_duration_days?: number | null;
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this subscription. By default, a subscription only considers usage events
+     * associated with its attached customer's customer_id. When usage_customer_ids is
+     * provided, the subscription includes usage events from the specified customers
+     * only. Provided usage_customer_ids must be either the customer for this
+     * subscription itself, or any of that customer's children.
+     */
+    usage_customer_ids?: Array<string> | null;
 }
 export declare namespace SubscriptionCreateParams {
     interface AddAdjustment {
@@ -6612,7 +6622,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 +6727,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 +6837,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 +6964,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 +7085,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 +7212,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 +7321,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 +7443,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 +7559,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 +7658,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 +7757,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 +7856,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 +7955,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 +8054,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 +8153,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 +8253,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 +8352,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 +8451,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 +8749,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 +8854,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 +8964,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 +9091,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 +9212,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 +9339,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 +9448,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 +9570,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 +9686,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 +9785,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 +9884,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 +9983,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 +10082,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 +10181,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 +10280,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 +10380,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 +10479,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 +10578,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 +10930,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 +11029,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 +11133,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 +11254,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 +11379,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 +11494,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 +11615,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 +11718,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 +11834,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 +11944,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 +12037,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 +12131,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 +12223,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 +12316,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 +12409,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 +12502,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 +12595,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 +12688,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 +12781,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 +12875,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 +12968,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 +13061,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 +13153,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 +13247,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 +13340,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 +13432,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 +13525,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 +13619,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';
@@ -13954,6 +13964,15 @@ export interface SubscriptionSchedulePlanChangeParams {
      * skipped.
      */
     trial_duration_days?: number | null;
+    /**
+     * A list of customer IDs whose usage events will be aggregated and billed under
+     * this subscription. By default, a subscription only considers usage events
+     * associated with its attached customer's customer_id. When usage_customer_ids is
+     * provided, the subscription includes usage events from the specified customers
+     * only. Provided usage_customer_ids must be either the customer for this
+     * subscription itself, or any of that customer's children.
+     */
+    usage_customer_ids?: Array<string> | null;
 }
 export declare namespace SubscriptionSchedulePlanChangeParams {
     interface AddAdjustment {
@@ -14144,7 +14163,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 +14268,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 +14378,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 +14505,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 +14626,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 +14753,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 +14862,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 +14984,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 +15100,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 +15199,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 +15298,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 +15397,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 +15496,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 +15595,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 +15694,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 +15794,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 +15893,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 +15992,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 +16290,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 +16395,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 +16505,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 +16632,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 +16753,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 +16880,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 +16989,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 +17111,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 +17227,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 +17326,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 +17425,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 +17524,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 +17623,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 +17722,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 +17821,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 +17921,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 +18020,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 +18119,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';