orb-billing 2.2.0 → 2.4.0

package/resources/subscriptions.d.ts

@@ -1,6 +1,7 @@
 import * as Core from 'orb-billing/core';
 import { APIResource } from 'orb-billing/resource';
 import * as SubscriptionsAPI from 'orb-billing/resources/subscriptions';
+import * as Shared from 'orb-billing/resources/shared';
 import * as CustomersAPI from 'orb-billing/resources/customers/customers';
 import * as PlansAPI from 'orb-billing/resources/plans/plans';
 import * as PricesAPI from 'orb-billing/resources/prices/prices';
@@ -400,6 +401,13 @@ export declare class Subscriptions extends APIResource {
      */
     create(body?: SubscriptionCreateParams, options?: Core.RequestOptions): Core.APIPromise<Subscription>;
     create(options?: Core.RequestOptions): Core.APIPromise<Subscription>;
+    /**
+     * This endpoint can be used to update the `metadata`, `net terms`,
+     * `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties
+     * on a subscription.
+     */
+    update(subscriptionId: string, body?: SubscriptionUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Subscription>;
+    update(subscriptionId: string, options?: Core.RequestOptions): Core.APIPromise<Subscription>;
     /**
      * This endpoint returns a list of all subscriptions for an account as a
      * [paginated](../reference/pagination) list, ordered starting from the most
@@ -795,6 +803,11 @@ export declare class Subscriptions extends APIResource {
      * default for the plan. The request format for price overrides, maximums, and
      * minimums are the same as those in [subscription creation](create-subscription).
      *
+     * ## Scheduling multiple plan changes
+     *
+     * When scheduling multiple plan changes with the same date, the latest plan change
+     * on that day takes effect.
+     *
      * ## Prorations for in-advance fees
      *
      * By default, Orb calculates the prorated difference in any fixed fees when making
@@ -1422,7 +1435,7 @@ export declare namespace SubscriptionUsage {
     }
     interface GroupedSubscriptionUsage {
         data: Array<GroupedSubscriptionUsage.Data>;
-        pagination_metadata?: GroupedSubscriptionUsage.PaginationMetadata | null;
+        pagination_metadata?: Shared.PaginationMetadata | null;
     }
     namespace GroupedSubscriptionUsage {
         interface Data {
@@ -1446,21 +1459,11 @@ export declare namespace SubscriptionUsage {
                 timeframe_start: string;
             }
         }
-        interface PaginationMetadata {
-            has_more: boolean;
-            next_cursor: string | null;
-        }
     }
 }
 export interface Subscriptions {
     data: Array<Subscription>;
-    pagination_metadata: Subscriptions.PaginationMetadata;
-}
-export declare namespace Subscriptions {
-    interface PaginationMetadata {
-        has_more: boolean;
-        next_cursor: string | null;
-    }
+    pagination_metadata: Shared.PaginationMetadata;
 }
 export interface SubscriptionFetchCostsResponse {
     data: Array<SubscriptionFetchCostsResponse.Data>;
@@ -1791,6 +1794,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         model_type: 'unit';
         unit_config: OverrideUnitPrice.UnitConfig;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -1849,6 +1861,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         model_type: 'package';
         package_config: OverridePackagePrice.PackageConfig;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -1876,7 +1897,7 @@ export declare namespace SubscriptionCreateParams {
              * An integer amount to represent package size. For example, 1000 here would divide
              * usage by 1000 before multiplying by package_amount in rating
              */
-            package_size?: number | null;
+            package_size: number;
         }
         /**
          * The subscription's override discount for the plan.
@@ -1912,6 +1933,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         matrix_config: OverrideMatrixPrice.MatrixConfig;
         model_type: 'matrix';
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -1992,6 +2022,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         model_type: 'tiered';
         tiered_config: OverrideTieredPrice.TieredConfig;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -2066,6 +2105,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         model_type: 'tiered_bps';
         tiered_bps_config: OverrideTieredBpsPrice.TieredBpsConfig;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -2145,6 +2193,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         bps_config: OverrideBpsPrice.BpsConfig;
         model_type: 'bps';
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -2207,6 +2264,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         bulk_bps_config: OverrideBulkBpsPrice.BulkBpsConfig;
         model_type: 'bulk_bps';
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -2282,6 +2348,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         bulk_config: OverrideBulkPrice.BulkConfig;
         model_type: 'bulk';
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -2352,6 +2427,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         model_type: 'threshold_total_amount';
         threshold_total_amount_config: Record<string, unknown>;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -2404,6 +2488,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         model_type: 'tiered_package';
         tiered_package_config: Record<string, unknown>;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -2456,6 +2549,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         model_type: 'tiered_with_minimum';
         tiered_with_minimum_config: Record<string, unknown>;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -2508,6 +2610,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         model_type: 'package_with_allocation';
         package_with_allocation_config: Record<string, unknown>;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -2560,6 +2671,15 @@ export declare namespace SubscriptionCreateParams {
         id: string;
         model_type: 'unit_with_percent';
         unit_with_percent_config: Record<string, unknown>;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -2609,6 +2729,38 @@ export declare namespace SubscriptionCreateParams {
         }
     }
 }
+export interface SubscriptionUpdateParams {
+    /**
+     * Determines whether issued invoices for this subscription will automatically be
+     * charged with the saved payment method on the due date. This property defaults to
+     * the plan's behavior.
+     */
+    auto_collection?: boolean | null;
+    /**
+     * Determines the default memo on this subscription's invoices. Note that if this
+     * is not provided, it is determined by the plan configuration.
+     */
+    default_invoice_memo?: string | null;
+    /**
+     * When this subscription's accrued usage reaches this threshold, an invoice will
+     * be issued for the subscription. If not specified, invoices will only be issued
+     * at the end of the billing period.
+     */
+    invoicing_threshold?: string | null;
+    /**
+     * User-specified key/value pairs for the resource. Individual keys can be removed
+     * by setting the value to `null`, and the entire metadata mapping can be cleared
+     * by setting `metadata` to `null`.
+     */
+    metadata?: Record<string, string | null> | null;
+    /**
+     * Determines the difference between the invoice issue date for subscription
+     * invoices as the date that they are due. A value of `0` here represents that the
+     * invoice is due on issue, whereas a value of `30` represents that the customer
+     * has a month to pay the invoice.
+     */
+    net_terms?: number | null;
+}
 export interface SubscriptionListParams extends PageParams {
     'created_at[gt]'?: string | null;
     'created_at[gte]'?: string | null;
@@ -2713,7 +2865,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
          * The start date of the price interval. This is the date that the price will start
          * billing on the subscription.
          */
-        start_date: (string & {}) | 'start_of_term' | 'end_of_term';
+        start_date: (string & {}) | Shared.BillingCycleRelativeDate;
         /**
          * A list of discounts to initialize on the price interval.
          */
@@ -2722,7 +2874,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
          * The end date of the price interval. This is the date that the price will stop
          * billing on the subscription.
          */
-        end_date?: (string & {}) | 'start_of_term' | 'end_of_term' | null;
+        end_date?: (string & {}) | Shared.BillingCycleRelativeDate | null;
         /**
          * The external price id of the price to add to the subscription.
          */
@@ -2813,6 +2965,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -2864,6 +3020,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -2888,7 +3048,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
                  * An integer amount to represent package size. For example, 1000 here would divide
                  * usage by 1000 before multiplying by package_amount in rating
                  */
-                package_size?: number | null;
+                package_size: number;
             }
         }
         interface NewFloatingMatrixPrice {
@@ -2920,6 +3080,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -2993,6 +3157,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3070,6 +3238,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3137,6 +3309,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3209,6 +3385,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3264,6 +3444,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3332,6 +3516,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3395,6 +3583,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3438,6 +3630,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3481,6 +3677,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3524,6 +3724,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3567,6 +3771,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3610,6 +3818,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3653,6 +3865,10 @@ export declare namespace SubscriptionPriceIntervalsParams {
              * this is true, and in-arrears if this is false.
              */
             billed_in_advance?: boolean | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
             /**
              * An alias for the price.
              */
@@ -3683,7 +3899,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
          * The updated end date of this price interval. If not specified, the start date
          * will not be updated.
          */
-        end_date?: (string & {}) | 'start_of_term' | 'end_of_term' | null;
+        end_date?: (string & {}) | Shared.BillingCycleRelativeDate | null;
         /**
          * A list of fixed fee quantity transitions to use for this price interval. Note
          * that this list will overwrite all existing fixed fee quantity transitions on the
@@ -3694,7 +3910,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
          * The updated start date of this price interval. If not specified, the start date
          * will not be updated.
          */
-        start_date?: (string & {}) | 'start_of_term' | 'end_of_term';
+        start_date?: (string & {}) | Shared.BillingCycleRelativeDate;
     }
     namespace Edit {
         interface FixedFeeQuantityTransition {
@@ -3765,6 +3981,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         model_type: 'unit';
         unit_config: OverrideUnitPrice.UnitConfig;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -3823,6 +4048,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         model_type: 'package';
         package_config: OverridePackagePrice.PackageConfig;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -3850,7 +4084,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
              * An integer amount to represent package size. For example, 1000 here would divide
              * usage by 1000 before multiplying by package_amount in rating
              */
-            package_size?: number | null;
+            package_size: number;
         }
         /**
          * The subscription's override discount for the plan.
@@ -3886,6 +4120,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         matrix_config: OverrideMatrixPrice.MatrixConfig;
         model_type: 'matrix';
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -3966,6 +4209,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         model_type: 'tiered';
         tiered_config: OverrideTieredPrice.TieredConfig;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -4040,6 +4292,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         model_type: 'tiered_bps';
         tiered_bps_config: OverrideTieredBpsPrice.TieredBpsConfig;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -4119,6 +4380,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         bps_config: OverrideBpsPrice.BpsConfig;
         model_type: 'bps';
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -4181,6 +4451,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         bulk_bps_config: OverrideBulkBpsPrice.BulkBpsConfig;
         model_type: 'bulk_bps';
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -4256,6 +4535,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         bulk_config: OverrideBulkPrice.BulkConfig;
         model_type: 'bulk';
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -4326,6 +4614,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         model_type: 'threshold_total_amount';
         threshold_total_amount_config: Record<string, unknown>;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -4378,6 +4675,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         model_type: 'tiered_package';
         tiered_package_config: Record<string, unknown>;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -4430,6 +4736,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         model_type: 'tiered_with_minimum';
         tiered_with_minimum_config: Record<string, unknown>;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -4482,6 +4797,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         model_type: 'package_with_allocation';
         package_with_allocation_config: Record<string, unknown>;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -4534,6 +4858,15 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         id: string;
         model_type: 'unit_with_percent';
         unit_with_percent_config: Record<string, unknown>;
+        /**
+         * The per unit conversion rate of the price currency to the invoicing currency.
+         */
+        conversion_rate?: number | null;
+        /**
+         * The currency of the price. If not provided, the currency of the plan will be
+         * used.
+         */
+        currency?: string | null;
         /**
          * The subscription's override discount for the plan.
          */
@@ -4624,6 +4957,7 @@ export declare namespace Subscriptions {
     export import SubscriptionsPage = SubscriptionsAPI.SubscriptionsPage;
     export import SubscriptionFetchScheduleResponsesPage = SubscriptionsAPI.SubscriptionFetchScheduleResponsesPage;
     export import SubscriptionCreateParams = SubscriptionsAPI.SubscriptionCreateParams;
+    export import SubscriptionUpdateParams = SubscriptionsAPI.SubscriptionUpdateParams;
     export import SubscriptionListParams = SubscriptionsAPI.SubscriptionListParams;
     export import SubscriptionCancelParams = SubscriptionsAPI.SubscriptionCancelParams;
     export import SubscriptionFetchCostsParams = SubscriptionsAPI.SubscriptionFetchCostsParams;