orb-billing 2.3.0 → 2.4.0

package/resources/subscriptions.d.ts

@@ -803,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
@@ -1789,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.
          */
@@ -1847,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.
          */
@@ -1874,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.
@@ -1910,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.
          */
@@ -1990,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.
          */
@@ -2064,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.
          */
@@ -2143,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.
          */
@@ -2205,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.
          */
@@ -2280,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.
          */
@@ -2350,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.
          */
@@ -2402,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.
          */
@@ -2454,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.
          */
@@ -2506,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.
          */
@@ -2558,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.
          */
@@ -2843,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.
              */
@@ -2894,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.
              */
@@ -2918,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 {
@@ -2950,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.
              */
@@ -3023,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.
              */
@@ -3100,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.
              */
@@ -3167,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.
              */
@@ -3239,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.
              */
@@ -3294,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.
              */
@@ -3362,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.
              */
@@ -3425,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.
              */
@@ -3468,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.
              */
@@ -3511,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.
              */
@@ -3554,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.
              */
@@ -3597,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.
              */
@@ -3640,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.
              */
@@ -3683,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.
              */
@@ -3795,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.
          */
@@ -3853,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.
          */
@@ -3880,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.
@@ -3916,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.
          */
@@ -3996,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.
          */
@@ -4070,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.
          */
@@ -4149,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.
          */
@@ -4211,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.
          */
@@ -4286,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.
          */
@@ -4356,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.
          */
@@ -4408,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.
          */
@@ -4460,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.
          */
@@ -4512,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.
          */
@@ -4564,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.
          */