orb-billing 4.71.6 → 4.72.0

package/resources/subscriptions.d.ts

@@ -1,5 +1,7 @@
 import { APIResource } from "../resource.js";
 import * as Core from "../core.js";
+import * as CreditNotesAPI from "./credit-notes.js";
+import * as InvoicesAPI from "./invoices.js";
 import * as Shared from "./shared.js";
 import * as CustomersAPI from "./customers/customers.js";
 import * as PlansAPI from "./plans/plans.js";
@@ -1022,6 +1024,10 @@ export interface Subscription {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: Subscription.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -1337,6 +1343,12 @@ export declare namespace Subscription {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -1566,6 +1578,10 @@ export interface SubscriptionCreateResponse {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: SubscriptionCreateResponse.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -1584,6 +1600,12 @@ export interface SubscriptionCreateResponse {
     start_date: string;
     status: 'active' | 'ended' | 'upcoming';
     trial_info: SubscriptionCreateResponse.TrialInfo;
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    changed_resources?: SubscriptionCreateResponse.ChangedResources | null;
 }
 export declare namespace SubscriptionCreateResponse {
     interface AdjustmentInterval {
@@ -1881,6 +1903,12 @@ export declare namespace SubscriptionCreateResponse {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -1957,6 +1985,29 @@ export declare namespace SubscriptionCreateResponse {
     interface TrialInfo {
         end_date: string | null;
     }
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    interface ChangedResources {
+        /**
+         * The credit notes that were created as part of this operation.
+         */
+        created_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were created as part of this operation.
+         */
+        created_invoices: Array<InvoicesAPI.Invoice>;
+        /**
+         * The credit notes that were voided as part of this operation.
+         */
+        voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were voided as part of this operation.
+         */
+        voided_invoices: Array<InvoicesAPI.Invoice>;
+    }
 }
 export interface SubscriptionCancelResponse {
     id: string;
@@ -2055,6 +2106,10 @@ export interface SubscriptionCancelResponse {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: SubscriptionCancelResponse.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -2073,6 +2128,12 @@ export interface SubscriptionCancelResponse {
     start_date: string;
     status: 'active' | 'ended' | 'upcoming';
     trial_info: SubscriptionCancelResponse.TrialInfo;
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    changed_resources?: SubscriptionCancelResponse.ChangedResources | null;
 }
 export declare namespace SubscriptionCancelResponse {
     interface AdjustmentInterval {
@@ -2370,6 +2431,12 @@ export declare namespace SubscriptionCancelResponse {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -2446,6 +2513,29 @@ export declare namespace SubscriptionCancelResponse {
     interface TrialInfo {
         end_date: string | null;
     }
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    interface ChangedResources {
+        /**
+         * The credit notes that were created as part of this operation.
+         */
+        created_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were created as part of this operation.
+         */
+        created_invoices: Array<InvoicesAPI.Invoice>;
+        /**
+         * The credit notes that were voided as part of this operation.
+         */
+        voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were voided as part of this operation.
+         */
+        voided_invoices: Array<InvoicesAPI.Invoice>;
+    }
 }
 export interface SubscriptionFetchCostsResponse {
     data: Array<SubscriptionFetchCostsResponse.Data>;
@@ -2604,6 +2694,10 @@ export interface SubscriptionPriceIntervalsResponse {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: SubscriptionPriceIntervalsResponse.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -2622,6 +2716,12 @@ export interface SubscriptionPriceIntervalsResponse {
     start_date: string;
     status: 'active' | 'ended' | 'upcoming';
     trial_info: SubscriptionPriceIntervalsResponse.TrialInfo;
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    changed_resources?: SubscriptionPriceIntervalsResponse.ChangedResources | null;
 }
 export declare namespace SubscriptionPriceIntervalsResponse {
     interface AdjustmentInterval {
@@ -2919,6 +3019,12 @@ export declare namespace SubscriptionPriceIntervalsResponse {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -2995,6 +3101,29 @@ export declare namespace SubscriptionPriceIntervalsResponse {
     interface TrialInfo {
         end_date: string | null;
     }
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    interface ChangedResources {
+        /**
+         * The credit notes that were created as part of this operation.
+         */
+        created_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were created as part of this operation.
+         */
+        created_invoices: Array<InvoicesAPI.Invoice>;
+        /**
+         * The credit notes that were voided as part of this operation.
+         */
+        voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were voided as part of this operation.
+         */
+        voided_invoices: Array<InvoicesAPI.Invoice>;
+    }
 }
 export interface SubscriptionSchedulePlanChangeResponse {
     id: string;
@@ -3093,6 +3222,10 @@ export interface SubscriptionSchedulePlanChangeResponse {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: SubscriptionSchedulePlanChangeResponse.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -3111,6 +3244,12 @@ export interface SubscriptionSchedulePlanChangeResponse {
     start_date: string;
     status: 'active' | 'ended' | 'upcoming';
     trial_info: SubscriptionSchedulePlanChangeResponse.TrialInfo;
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    changed_resources?: SubscriptionSchedulePlanChangeResponse.ChangedResources | null;
 }
 export declare namespace SubscriptionSchedulePlanChangeResponse {
     interface AdjustmentInterval {
@@ -3408,6 +3547,12 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -3484,6 +3629,29 @@ export declare namespace SubscriptionSchedulePlanChangeResponse {
     interface TrialInfo {
         end_date: string | null;
     }
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    interface ChangedResources {
+        /**
+         * The credit notes that were created as part of this operation.
+         */
+        created_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were created as part of this operation.
+         */
+        created_invoices: Array<InvoicesAPI.Invoice>;
+        /**
+         * The credit notes that were voided as part of this operation.
+         */
+        voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were voided as part of this operation.
+         */
+        voided_invoices: Array<InvoicesAPI.Invoice>;
+    }
 }
 export interface SubscriptionTriggerPhaseResponse {
     id: string;
@@ -3582,6 +3750,10 @@ export interface SubscriptionTriggerPhaseResponse {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: SubscriptionTriggerPhaseResponse.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -3600,6 +3772,12 @@ export interface SubscriptionTriggerPhaseResponse {
     start_date: string;
     status: 'active' | 'ended' | 'upcoming';
     trial_info: SubscriptionTriggerPhaseResponse.TrialInfo;
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    changed_resources?: SubscriptionTriggerPhaseResponse.ChangedResources | null;
 }
 export declare namespace SubscriptionTriggerPhaseResponse {
     interface AdjustmentInterval {
@@ -3897,6 +4075,12 @@ export declare namespace SubscriptionTriggerPhaseResponse {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -3973,6 +4157,29 @@ export declare namespace SubscriptionTriggerPhaseResponse {
     interface TrialInfo {
         end_date: string | null;
     }
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    interface ChangedResources {
+        /**
+         * The credit notes that were created as part of this operation.
+         */
+        created_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were created as part of this operation.
+         */
+        created_invoices: Array<InvoicesAPI.Invoice>;
+        /**
+         * The credit notes that were voided as part of this operation.
+         */
+        voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were voided as part of this operation.
+         */
+        voided_invoices: Array<InvoicesAPI.Invoice>;
+    }
 }
 export interface SubscriptionUnscheduleCancellationResponse {
     id: string;
@@ -4071,6 +4278,10 @@ export interface SubscriptionUnscheduleCancellationResponse {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: SubscriptionUnscheduleCancellationResponse.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -4089,6 +4300,12 @@ export interface SubscriptionUnscheduleCancellationResponse {
     start_date: string;
     status: 'active' | 'ended' | 'upcoming';
     trial_info: SubscriptionUnscheduleCancellationResponse.TrialInfo;
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    changed_resources?: SubscriptionUnscheduleCancellationResponse.ChangedResources | null;
 }
 export declare namespace SubscriptionUnscheduleCancellationResponse {
     interface AdjustmentInterval {
@@ -4386,6 +4603,12 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -4462,6 +4685,29 @@ export declare namespace SubscriptionUnscheduleCancellationResponse {
     interface TrialInfo {
         end_date: string | null;
     }
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    interface ChangedResources {
+        /**
+         * The credit notes that were created as part of this operation.
+         */
+        created_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were created as part of this operation.
+         */
+        created_invoices: Array<InvoicesAPI.Invoice>;
+        /**
+         * The credit notes that were voided as part of this operation.
+         */
+        voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were voided as part of this operation.
+         */
+        voided_invoices: Array<InvoicesAPI.Invoice>;
+    }
 }
 export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
     id: string;
@@ -4560,6 +4806,10 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -4578,6 +4828,12 @@ export interface SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
     start_date: string;
     status: 'active' | 'ended' | 'upcoming';
     trial_info: SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse.TrialInfo;
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    changed_resources?: SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse.ChangedResources | null;
 }
 export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
     interface AdjustmentInterval {
@@ -4875,6 +5131,12 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -4951,6 +5213,29 @@ export declare namespace SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse {
     interface TrialInfo {
         end_date: string | null;
     }
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    interface ChangedResources {
+        /**
+         * The credit notes that were created as part of this operation.
+         */
+        created_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were created as part of this operation.
+         */
+        created_invoices: Array<InvoicesAPI.Invoice>;
+        /**
+         * The credit notes that were voided as part of this operation.
+         */
+        voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were voided as part of this operation.
+         */
+        voided_invoices: Array<InvoicesAPI.Invoice>;
+    }
 }
 export interface SubscriptionUnschedulePendingPlanChangesResponse {
     id: string;
@@ -5049,6 +5334,10 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: SubscriptionUnschedulePendingPlanChangesResponse.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -5067,6 +5356,12 @@ export interface SubscriptionUnschedulePendingPlanChangesResponse {
     start_date: string;
     status: 'active' | 'ended' | 'upcoming';
     trial_info: SubscriptionUnschedulePendingPlanChangesResponse.TrialInfo;
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    changed_resources?: SubscriptionUnschedulePendingPlanChangesResponse.ChangedResources | null;
 }
 export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
     interface AdjustmentInterval {
@@ -5364,6 +5659,12 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -5440,6 +5741,29 @@ export declare namespace SubscriptionUnschedulePendingPlanChangesResponse {
     interface TrialInfo {
         end_date: string | null;
     }
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    interface ChangedResources {
+        /**
+         * The credit notes that were created as part of this operation.
+         */
+        created_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were created as part of this operation.
+         */
+        created_invoices: Array<InvoicesAPI.Invoice>;
+        /**
+         * The credit notes that were voided as part of this operation.
+         */
+        voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were voided as part of this operation.
+         */
+        voided_invoices: Array<InvoicesAPI.Invoice>;
+    }
 }
 export interface SubscriptionUpdateFixedFeeQuantityResponse {
     id: string;
@@ -5538,6 +5862,10 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: SubscriptionUpdateFixedFeeQuantityResponse.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -5556,6 +5884,12 @@ export interface SubscriptionUpdateFixedFeeQuantityResponse {
     start_date: string;
     status: 'active' | 'ended' | 'upcoming';
     trial_info: SubscriptionUpdateFixedFeeQuantityResponse.TrialInfo;
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    changed_resources?: SubscriptionUpdateFixedFeeQuantityResponse.ChangedResources | null;
 }
 export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
     interface AdjustmentInterval {
@@ -5853,6 +6187,12 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -5929,6 +6269,29 @@ export declare namespace SubscriptionUpdateFixedFeeQuantityResponse {
     interface TrialInfo {
         end_date: string | null;
     }
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    interface ChangedResources {
+        /**
+         * The credit notes that were created as part of this operation.
+         */
+        created_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were created as part of this operation.
+         */
+        created_invoices: Array<InvoicesAPI.Invoice>;
+        /**
+         * The credit notes that were voided as part of this operation.
+         */
+        voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were voided as part of this operation.
+         */
+        voided_invoices: Array<InvoicesAPI.Invoice>;
+    }
 }
 export interface SubscriptionUpdateTrialResponse {
     id: string;
@@ -6027,6 +6390,10 @@ export interface SubscriptionUpdateTrialResponse {
      * has a month to pay the invoice.
      */
     net_terms: number;
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    pending_subscription_change: SubscriptionUpdateTrialResponse.PendingSubscriptionChange | null;
     /**
      * The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
      * subscribed to by a customer. Plans define the billing behavior of the
@@ -6045,6 +6412,12 @@ export interface SubscriptionUpdateTrialResponse {
     start_date: string;
     status: 'active' | 'ended' | 'upcoming';
     trial_info: SubscriptionUpdateTrialResponse.TrialInfo;
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    changed_resources?: SubscriptionUpdateTrialResponse.ChangedResources | null;
 }
 export declare namespace SubscriptionUpdateTrialResponse {
     interface AdjustmentInterval {
@@ -6342,6 +6715,12 @@ export declare namespace SubscriptionUpdateTrialResponse {
          */
         start_date: string;
     }
+    /**
+     * A pending subscription change if one exists on this subscription.
+     */
+    interface PendingSubscriptionChange {
+        id: string;
+    }
     /**
      * The Price Interval resource represents a period of time for which a price will
      * bill on a subscription. A subscription’s price intervals define its billing
@@ -6418,6 +6797,29 @@ export declare namespace SubscriptionUpdateTrialResponse {
     interface TrialInfo {
         end_date: string | null;
     }
+    /**
+     * The resources that were changed as part of this operation. Only present when
+     * fetched through the subscription changes API or if the
+     * `include_changed_resources` parameter was passed in the request.
+     */
+    interface ChangedResources {
+        /**
+         * The credit notes that were created as part of this operation.
+         */
+        created_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were created as part of this operation.
+         */
+        created_invoices: Array<InvoicesAPI.Invoice>;
+        /**
+         * The credit notes that were voided as part of this operation.
+         */
+        voided_credit_notes: Array<CreditNotesAPI.CreditNote>;
+        /**
+         * The invoices that were voided as part of this operation.
+         */
+        voided_invoices: Array<InvoicesAPI.Invoice>;
+    }
 }
 export interface SubscriptionCreateParams {
     /**
@@ -7147,7 +7549,7 @@ export declare namespace SubscriptionCreateParams {
             namespace TieredConfig {
                 interface Tier {
                     /**
-                     * Inclusive tier starting value
+                     * Exclusive tier starting value
                      */
                     first_unit: number;
                     /**
@@ -7155,7 +7557,7 @@ export declare namespace SubscriptionCreateParams {
                      */
                     unit_amount: string;
                     /**
-                     * Exclusive tier ending value. If null, this is treated as the last tier
+                     * Inclusive tier ending value. If null, this is treated as the last tier
                      */
                     last_unit?: number | null;
                 }
@@ -7273,11 +7675,11 @@ export declare namespace SubscriptionCreateParams {
                      */
                     bps: number;
                     /**
-                     * Inclusive tier starting value
+                     * Exclusive tier starting value
                      */
                     minimum_amount: string;
                     /**
-                     * Exclusive tier ending value
+                     * Inclusive tier ending value
                      */
                     maximum_amount?: string | null;
                     /**
@@ -9967,7 +10369,7 @@ export declare namespace SubscriptionCreateParams {
             namespace TieredConfig {
                 interface Tier {
                     /**
-                     * Inclusive tier starting value
+                     * Exclusive tier starting value
                      */
                     first_unit: number;
                     /**
@@ -9975,7 +10377,7 @@ export declare namespace SubscriptionCreateParams {
                      */
                     unit_amount: string;
                     /**
-                     * Exclusive tier ending value. If null, this is treated as the last tier
+                     * Inclusive tier ending value. If null, this is treated as the last tier
                      */
                     last_unit?: number | null;
                 }
@@ -10093,11 +10495,11 @@ export declare namespace SubscriptionCreateParams {
                      */
                     bps: number;
                     /**
-                     * Inclusive tier starting value
+                     * Exclusive tier starting value
                      */
                     minimum_amount: string;
                     /**
-                     * Exclusive tier ending value
+                     * Inclusive tier ending value
                      */
                     maximum_amount?: string | null;
                     /**
@@ -12954,7 +13356,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
             namespace TieredConfig {
                 interface Tier {
                     /**
-                     * Inclusive tier starting value
+                     * Exclusive tier starting value
                      */
                     first_unit: number;
                     /**
@@ -12962,7 +13364,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
                      */
                     unit_amount: string;
                     /**
-                     * Exclusive tier ending value. If null, this is treated as the last tier
+                     * Inclusive tier ending value. If null, this is treated as the last tier
                      */
                     last_unit?: number | null;
                 }
@@ -13074,11 +13476,11 @@ export declare namespace SubscriptionPriceIntervalsParams {
                      */
                     bps: number;
                     /**
-                     * Inclusive tier starting value
+                     * Exclusive tier starting value
                      */
                     minimum_amount: string;
                     /**
-                     * Exclusive tier ending value
+                     * Inclusive tier ending value
                      */
                     maximum_amount?: string | null;
                     /**
@@ -16110,7 +16512,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
             namespace TieredConfig {
                 interface Tier {
                     /**
-                     * Inclusive tier starting value
+                     * Exclusive tier starting value
                      */
                     first_unit: number;
                     /**
@@ -16118,7 +16520,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
                      */
                     unit_amount: string;
                     /**
-                     * Exclusive tier ending value. If null, this is treated as the last tier
+                     * Inclusive tier ending value. If null, this is treated as the last tier
                      */
                     last_unit?: number | null;
                 }
@@ -16236,11 +16638,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
                      */
                     bps: number;
                     /**
-                     * Inclusive tier starting value
+                     * Exclusive tier starting value
                      */
                     minimum_amount: string;
                     /**
-                     * Exclusive tier ending value
+                     * Inclusive tier ending value
                      */
                     maximum_amount?: string | null;
                     /**
@@ -18930,7 +19332,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
             namespace TieredConfig {
                 interface Tier {
                     /**
-                     * Inclusive tier starting value
+                     * Exclusive tier starting value
                      */
                     first_unit: number;
                     /**
@@ -18938,7 +19340,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
                      */
                     unit_amount: string;
                     /**
-                     * Exclusive tier ending value. If null, this is treated as the last tier
+                     * Inclusive tier ending value. If null, this is treated as the last tier
                      */
                     last_unit?: number | null;
                 }
@@ -19056,11 +19458,11 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
                      */
                     bps: number;
                     /**
-                     * Inclusive tier starting value
+                     * Exclusive tier starting value
                      */
                     minimum_amount: string;
                     /**
-                     * Exclusive tier ending value
+                     * Inclusive tier ending value
                      */
                     maximum_amount?: string | null;
                     /**