orb-billing 4.58.0 → 4.60.0

package/src/resources/subscriptions.ts

@@ -814,9 +814,9 @@ export 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
@@ -875,8 +875,9 @@ export 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
    *
@@ -8026,6 +8027,16 @@ 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 namespace SubscriptionCreateParams {
@@ -8285,7 +8296,7 @@ export 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;
 
@@ -8411,7 +8422,7 @@ export 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;
 
@@ -8543,7 +8554,7 @@ export 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;
 
@@ -8695,7 +8706,7 @@ export 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;
 
@@ -8840,7 +8851,7 @@ export 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;
 
@@ -8993,7 +9004,7 @@ export 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;
 
@@ -9124,7 +9135,7 @@ export 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;
 
@@ -9270,7 +9281,7 @@ export 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;
 
@@ -9408,7 +9419,7 @@ export 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;
 
@@ -9527,7 +9538,7 @@ export 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;
 
@@ -9646,7 +9657,7 @@ export 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;
 
@@ -9765,7 +9776,7 @@ export 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;
 
@@ -9884,7 +9895,7 @@ export 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;
 
@@ -10003,7 +10014,7 @@ export 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;
 
@@ -10122,7 +10133,7 @@ export 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;
 
@@ -10243,7 +10254,7 @@ export namespace SubscriptionCreateParams {
       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;
 
@@ -10362,7 +10373,7 @@ export namespace SubscriptionCreateParams {
       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;
 
@@ -10481,7 +10492,7 @@ export 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;
 
@@ -10868,7 +10879,7 @@ export 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;
 
@@ -10994,7 +11005,7 @@ export 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;
 
@@ -11126,7 +11137,7 @@ export 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;
 
@@ -11278,7 +11289,7 @@ export 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;
 
@@ -11423,7 +11434,7 @@ export 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;
 
@@ -11576,7 +11587,7 @@ export 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;
 
@@ -11707,7 +11718,7 @@ export 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;
 
@@ -11853,7 +11864,7 @@ export 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;
 
@@ -11991,7 +12002,7 @@ export 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;
 
@@ -12110,7 +12121,7 @@ export 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;
 
@@ -12229,7 +12240,7 @@ export 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;
 
@@ -12348,7 +12359,7 @@ export 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;
 
@@ -12467,7 +12478,7 @@ export 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;
 
@@ -12586,7 +12597,7 @@ export 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;
 
@@ -12705,7 +12716,7 @@ export 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;
 
@@ -12826,7 +12837,7 @@ export namespace SubscriptionCreateParams {
       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;
 
@@ -12945,7 +12956,7 @@ export namespace SubscriptionCreateParams {
       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;
 
@@ -13064,7 +13075,7 @@ export 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;
 
@@ -13529,7 +13540,7 @@ export 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;
 
@@ -13648,7 +13659,7 @@ export 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;
 
@@ -13773,7 +13784,7 @@ export 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;
 
@@ -13918,7 +13929,7 @@ export 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;
 
@@ -14068,7 +14079,7 @@ export 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;
 
@@ -14206,7 +14217,7 @@ export 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;
 
@@ -14352,7 +14363,7 @@ export 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;
 
@@ -14476,7 +14487,7 @@ export 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;
 
@@ -14615,7 +14626,7 @@ export 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;
 
@@ -14746,7 +14757,7 @@ export 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;
 
@@ -14858,7 +14869,7 @@ export 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;
 
@@ -14972,7 +14983,7 @@ export namespace SubscriptionPriceIntervalsParams {
       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;
 
@@ -15082,7 +15093,7 @@ export 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;
 
@@ -15194,7 +15205,7 @@ export 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;
 
@@ -15306,7 +15317,7 @@ export 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;
 
@@ -15418,7 +15429,7 @@ export 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;
 
@@ -15530,7 +15541,7 @@ export 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;
 
@@ -15642,7 +15653,7 @@ export 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;
 
@@ -15754,7 +15765,7 @@ export 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;
 
@@ -15868,7 +15879,7 @@ export namespace SubscriptionPriceIntervalsParams {
       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;
 
@@ -15980,7 +15991,7 @@ export namespace SubscriptionPriceIntervalsParams {
       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;
 
@@ -16092,7 +16103,7 @@ export namespace SubscriptionPriceIntervalsParams {
       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;
 
@@ -16202,7 +16213,7 @@ export 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;
 
@@ -16316,7 +16327,7 @@ export 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;
 
@@ -16428,7 +16439,7 @@ export namespace SubscriptionPriceIntervalsParams {
       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;
 
@@ -16538,7 +16549,7 @@ export 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;
 
@@ -16650,7 +16661,7 @@ export 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;
 
@@ -16764,7 +16775,7 @@ export 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;
 
@@ -17188,6 +17199,16 @@ 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 namespace SubscriptionSchedulePlanChangeParams {
@@ -17447,7 +17468,7 @@ export 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;
 
@@ -17573,7 +17594,7 @@ export 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;
 
@@ -17705,7 +17726,7 @@ export 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;
 
@@ -17857,7 +17878,7 @@ export 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;
 
@@ -18002,7 +18023,7 @@ export 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;
 
@@ -18155,7 +18176,7 @@ export 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;
 
@@ -18286,7 +18307,7 @@ export 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;
 
@@ -18432,7 +18453,7 @@ export 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;
 
@@ -18570,7 +18591,7 @@ export 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;
 
@@ -18689,7 +18710,7 @@ export 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;
 
@@ -18808,7 +18829,7 @@ export 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;
 
@@ -18927,7 +18948,7 @@ export 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;
 
@@ -19046,7 +19067,7 @@ export 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;
 
@@ -19165,7 +19186,7 @@ export 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;
 
@@ -19284,7 +19305,7 @@ export 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;
 
@@ -19405,7 +19426,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       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;
 
@@ -19524,7 +19545,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       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;
 
@@ -19643,7 +19664,7 @@ export 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;
 
@@ -20030,7 +20051,7 @@ export 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;
 
@@ -20156,7 +20177,7 @@ export 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;
 
@@ -20288,7 +20309,7 @@ export 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;
 
@@ -20440,7 +20461,7 @@ export 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;
 
@@ -20585,7 +20606,7 @@ export 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;
 
@@ -20738,7 +20759,7 @@ export 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;
 
@@ -20869,7 +20890,7 @@ export 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;
 
@@ -21015,7 +21036,7 @@ export 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;
 
@@ -21153,7 +21174,7 @@ export 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;
 
@@ -21272,7 +21293,7 @@ export 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;
 
@@ -21391,7 +21412,7 @@ export 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;
 
@@ -21510,7 +21531,7 @@ export 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;
 
@@ -21629,7 +21650,7 @@ export 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;
 
@@ -21748,7 +21769,7 @@ export 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;
 
@@ -21867,7 +21888,7 @@ export 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;
 
@@ -21988,7 +22009,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       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;
 
@@ -22107,7 +22128,7 @@ export namespace SubscriptionSchedulePlanChangeParams {
       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;
 
@@ -22226,7 +22247,7 @@ export 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;