orb-billing 5.38.0 → 5.41.0

package/resources/shared.d.ts

@@ -2447,9 +2447,6 @@ export declare namespace NewFloatingCumulativeGroupedBulkPrice {
          * Each tier lower bound must have the same group of values.
          */
         dimension_values: Array<CumulativeGroupedBulkConfig.DimensionValue>;
-        /**
-         * Grouping key name
-         */
         group: string;
     }
     namespace CumulativeGroupedBulkConfig {
@@ -2658,9 +2655,6 @@ export declare namespace NewFloatingGroupedTieredPackagePrice {
          * The event property used to group before tiering
          */
         grouping_key: string;
-        /**
-         * Package size
-         */
         package_size: string;
         /**
          * Apply tiered pricing after rounding up the quantity to the package size. Tiers
@@ -2674,12 +2668,9 @@ export declare namespace NewFloatingGroupedTieredPackagePrice {
          */
         interface Tier {
             /**
-             * Price per package
+             * Per package
              */
             per_unit: string;
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
         }
     }
@@ -2783,9 +2774,6 @@ export declare namespace NewFloatingGroupedTieredPrice {
          * Configuration for a single tier
          */
         interface Tier {
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
             /**
              * Per unit amount
@@ -2910,22 +2898,13 @@ export declare namespace NewFloatingGroupedWithMeteredMinimumPrice {
          * Configuration for a scaling factor
          */
         interface ScalingFactor {
-            /**
-             * Scaling factor
-             */
             scaling_factor: string;
-            /**
-             * Scaling value
-             */
             scaling_value: string;
         }
         /**
          * Configuration for a unit amount
          */
         interface UnitAmount {
-            /**
-             * Pricing value
-             */
             pricing_value: string;
             /**
              * Per unit amount
@@ -3391,9 +3370,6 @@ export declare namespace NewFloatingMaxGroupTieredPackagePrice {
          * The event property used to group before tiering the group with the highest value
          */
         grouping_key: string;
-        /**
-         * Package size
-         */
         package_size: string;
         /**
          * Apply tiered pricing to the largest group after grouping with the provided key.
@@ -3405,9 +3381,6 @@ export declare namespace NewFloatingMaxGroupTieredPackagePrice {
          * Configuration for a single tier
          */
         interface Tier {
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
             /**
              * Per unit amount
@@ -3430,13 +3403,13 @@ export interface NewFloatingMinimumCompositePrice {
      */
     item_id: string;
     /**
-     * Configuration for minimum pricing
+     * Configuration for minimum_composite pricing
      */
-    minimum_config: NewFloatingMinimumCompositePrice.MinimumConfig;
+    minimum_composite_config: NewFloatingMinimumCompositePrice.MinimumCompositeConfig;
     /**
      * The pricing model type
      */
-    model_type: 'minimum';
+    model_type: 'minimum_composite';
     /**
      * The name of the price.
      */
@@ -3497,9 +3470,9 @@ export interface NewFloatingMinimumCompositePrice {
 }
 export declare namespace NewFloatingMinimumCompositePrice {
     /**
-     * Configuration for minimum pricing
+     * Configuration for minimum_composite pricing
      */
-    interface MinimumConfig {
+    interface MinimumCompositeConfig {
         /**
          * The minimum amount to apply
          */
@@ -3673,17 +3646,8 @@ export declare namespace NewFloatingPackageWithAllocationPrice {
      * Configuration for package_with_allocation pricing
      */
     interface PackageWithAllocationConfig {
-        /**
-         * Usage allocation
-         */
         allocation: string;
-        /**
-         * Price per package
-         */
         package_amount: string;
-        /**
-         * Package size
-         */
         package_size: string;
     }
 }
@@ -3779,9 +3743,6 @@ export declare namespace NewFloatingScalableMatrixWithTieredPricingPrice {
          * Apply a scaling factor to each dimension
          */
         matrix_scaling_factors: Array<ScalableMatrixWithTieredPricingConfig.MatrixScalingFactor>;
-        /**
-         * Tier pricing structure
-         */
         tiers: Array<ScalableMatrixWithTieredPricingConfig.Tier>;
         /**
          * Used for the scalable matrix second dimension (optional)
@@ -3793,30 +3754,15 @@ export declare namespace NewFloatingScalableMatrixWithTieredPricingPrice {
          * Configuration for a single matrix scaling factor
          */
         interface MatrixScalingFactor {
-            /**
-             * First dimension value
-             */
             first_dimension_value: string;
-            /**
-             * Scaling factor
-             */
             scaling_factor: string;
-            /**
-             * Second dimension value (optional)
-             */
             second_dimension_value?: string | null;
         }
         /**
          * Configuration for a single tier entry with business logic
          */
         interface Tier {
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
-            /**
-             * Per unit amount
-             */
             unit_amount: string;
         }
     }
@@ -3931,17 +3877,8 @@ export declare namespace NewFloatingScalableMatrixWithUnitPricingPrice {
          * Configuration for a single matrix scaling factor
          */
         interface MatrixScalingFactor {
-            /**
-             * First dimension value
-             */
             first_dimension_value: string;
-            /**
-             * Scaling factor
-             */
             scaling_factor: string;
-            /**
-             * Second dimension value (optional)
-             */
             second_dimension_value?: string | null;
         }
     }
@@ -4045,9 +3982,6 @@ export declare namespace NewFloatingThresholdTotalAmountPrice {
          * Configuration for a single threshold
          */
         interface ConsumptionTable {
-            /**
-             * Quantity threshold
-             */
             threshold: string;
             /**
              * Total amount for this threshold
@@ -4140,9 +4074,6 @@ export declare namespace NewFloatingTieredPackagePrice {
      * Configuration for tiered_package pricing
      */
     interface TieredPackageConfig {
-        /**
-         * Package size
-         */
         package_size: string;
         /**
          * Apply tiered pricing after rounding up the quantity to the package size. Tiers
@@ -4161,9 +4092,6 @@ export declare namespace NewFloatingTieredPackagePrice {
              * Price per package
              */
             per_unit: string;
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
         }
     }
@@ -4252,9 +4180,6 @@ export declare namespace NewFloatingTieredPackageWithMinimumPrice {
      * Configuration for tiered_package_with_minimum pricing
      */
     interface TieredPackageWithMinimumConfig {
-        /**
-         * Package size
-         */
         package_size: number;
         /**
          * Apply tiered pricing after rounding up the quantity to the package size. Tiers
@@ -4267,17 +4192,8 @@ export declare namespace NewFloatingTieredPackageWithMinimumPrice {
          * Configuration for a single tier
          */
         interface Tier {
-            /**
-             * Minimum amount
-             */
             minimum_amount: string;
-            /**
-             * Price per package
-             */
             per_unit: string;
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
         }
     }
@@ -4464,13 +4380,7 @@ export declare namespace NewFloatingTieredWithMinimumPrice {
          * Configuration for a single tier
          */
         interface Tier {
-            /**
-             * Minimum amount
-             */
             minimum_amount: string;
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
             /**
              * Per unit amount
@@ -5289,9 +5199,6 @@ export declare namespace NewPlanCumulativeGroupedBulkPrice {
          * Each tier lower bound must have the same group of values.
          */
         dimension_values: Array<CumulativeGroupedBulkConfig.DimensionValue>;
-        /**
-         * Grouping key name
-         */
         group: string;
     }
     namespace CumulativeGroupedBulkConfig {
@@ -5512,9 +5419,6 @@ export declare namespace NewPlanGroupedTieredPackagePrice {
          * The event property used to group before tiering
          */
         grouping_key: string;
-        /**
-         * Package size
-         */
         package_size: string;
         /**
          * Apply tiered pricing after rounding up the quantity to the package size. Tiers
@@ -5528,12 +5432,9 @@ export declare namespace NewPlanGroupedTieredPackagePrice {
          */
         interface Tier {
             /**
-             * Price per package
+             * Per package
              */
             per_unit: string;
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
         }
     }
@@ -5643,9 +5544,6 @@ export declare namespace NewPlanGroupedTieredPrice {
          * Configuration for a single tier
          */
         interface Tier {
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
             /**
              * Per unit amount
@@ -5776,22 +5674,13 @@ export declare namespace NewPlanGroupedWithMeteredMinimumPrice {
          * Configuration for a scaling factor
          */
         interface ScalingFactor {
-            /**
-             * Scaling factor
-             */
             scaling_factor: string;
-            /**
-             * Scaling value
-             */
             scaling_value: string;
         }
         /**
          * Configuration for a unit amount
          */
         interface UnitAmount {
-            /**
-             * Pricing value
-             */
             pricing_value: string;
             /**
              * Per unit amount
@@ -6287,9 +6176,6 @@ export declare namespace NewPlanMaxGroupTieredPackagePrice {
          * The event property used to group before tiering the group with the highest value
          */
         grouping_key: string;
-        /**
-         * Package size
-         */
         package_size: string;
         /**
          * Apply tiered pricing to the largest group after grouping with the provided key.
@@ -6301,9 +6187,6 @@ export declare namespace NewPlanMaxGroupTieredPackagePrice {
          * Configuration for a single tier
          */
         interface Tier {
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
             /**
              * Per unit amount
@@ -6322,13 +6205,13 @@ export interface NewPlanMinimumCompositePrice {
      */
     item_id: string;
     /**
-     * Configuration for minimum pricing
+     * Configuration for minimum_composite pricing
      */
-    minimum_config: NewPlanMinimumCompositePrice.MinimumConfig;
+    minimum_composite_config: NewPlanMinimumCompositePrice.MinimumCompositeConfig;
     /**
      * The pricing model type
      */
-    model_type: 'minimum';
+    model_type: 'minimum_composite';
     /**
      * The name of the price.
      */
@@ -6399,9 +6282,9 @@ export interface NewPlanMinimumCompositePrice {
 }
 export declare namespace NewPlanMinimumCompositePrice {
     /**
-     * Configuration for minimum pricing
+     * Configuration for minimum_composite pricing
      */
-    interface MinimumConfig {
+    interface MinimumCompositeConfig {
         /**
          * The minimum amount to apply
          */
@@ -6587,17 +6470,8 @@ export declare namespace NewPlanPackageWithAllocationPrice {
      * Configuration for package_with_allocation pricing
      */
     interface PackageWithAllocationConfig {
-        /**
-         * Usage allocation
-         */
         allocation: string;
-        /**
-         * Price per package
-         */
         package_amount: string;
-        /**
-         * Package size
-         */
         package_size: string;
     }
 }
@@ -6699,9 +6573,6 @@ export declare namespace NewPlanScalableMatrixWithTieredPricingPrice {
          * Apply a scaling factor to each dimension
          */
         matrix_scaling_factors: Array<ScalableMatrixWithTieredPricingConfig.MatrixScalingFactor>;
-        /**
-         * Tier pricing structure
-         */
         tiers: Array<ScalableMatrixWithTieredPricingConfig.Tier>;
         /**
          * Used for the scalable matrix second dimension (optional)
@@ -6713,30 +6584,15 @@ export declare namespace NewPlanScalableMatrixWithTieredPricingPrice {
          * Configuration for a single matrix scaling factor
          */
         interface MatrixScalingFactor {
-            /**
-             * First dimension value
-             */
             first_dimension_value: string;
-            /**
-             * Scaling factor
-             */
             scaling_factor: string;
-            /**
-             * Second dimension value (optional)
-             */
             second_dimension_value?: string | null;
         }
         /**
          * Configuration for a single tier entry with business logic
          */
         interface Tier {
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
-            /**
-             * Per unit amount
-             */
             unit_amount: string;
         }
     }
@@ -6857,17 +6713,8 @@ export declare namespace NewPlanScalableMatrixWithUnitPricingPrice {
          * Configuration for a single matrix scaling factor
          */
         interface MatrixScalingFactor {
-            /**
-             * First dimension value
-             */
             first_dimension_value: string;
-            /**
-             * Scaling factor
-             */
             scaling_factor: string;
-            /**
-             * Second dimension value (optional)
-             */
             second_dimension_value?: string | null;
         }
     }
@@ -6977,9 +6824,6 @@ export declare namespace NewPlanThresholdTotalAmountPrice {
          * Configuration for a single threshold
          */
         interface ConsumptionTable {
-            /**
-             * Quantity threshold
-             */
             threshold: string;
             /**
              * Total amount for this threshold
@@ -7078,9 +6922,6 @@ export declare namespace NewPlanTieredPackagePrice {
      * Configuration for tiered_package pricing
      */
     interface TieredPackageConfig {
-        /**
-         * Package size
-         */
         package_size: string;
         /**
          * Apply tiered pricing after rounding up the quantity to the package size. Tiers
@@ -7099,9 +6940,6 @@ export declare namespace NewPlanTieredPackagePrice {
              * Price per package
              */
             per_unit: string;
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
         }
     }
@@ -7196,9 +7034,6 @@ export declare namespace NewPlanTieredPackageWithMinimumPrice {
      * Configuration for tiered_package_with_minimum pricing
      */
     interface TieredPackageWithMinimumConfig {
-        /**
-         * Package size
-         */
         package_size: number;
         /**
          * Apply tiered pricing after rounding up the quantity to the package size. Tiers
@@ -7211,17 +7046,8 @@ export declare namespace NewPlanTieredPackageWithMinimumPrice {
          * Configuration for a single tier
          */
         interface Tier {
-            /**
-             * Minimum amount
-             */
             minimum_amount: string;
-            /**
-             * Price per package
-             */
             per_unit: string;
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
         }
     }
@@ -7420,13 +7246,7 @@ export declare namespace NewPlanTieredWithMinimumPrice {
          * Configuration for a single tier
          */
         interface Tier {
-            /**
-             * Minimum amount
-             */
             minimum_amount: string;
-            /**
-             * Tier lower bound
-             */
             tier_lower_bound: string;
             /**
              * Per unit amount
@@ -8802,9 +8622,6 @@ export declare namespace Price {
              * Configuration for a single threshold
              */
             interface ConsumptionTable {
-                /**
-                 * Quantity threshold
-                 */
                 threshold: string;
                 /**
                  * Total amount for this threshold
@@ -8899,9 +8716,6 @@ export declare namespace Price {
          * Configuration for tiered_package pricing
          */
         interface TieredPackageConfig {
-            /**
-             * Package size
-             */
             package_size: string;
             /**
              * Apply tiered pricing after rounding up the quantity to the package size. Tiers
@@ -8920,9 +8734,6 @@ export declare namespace Price {
                  * Price per package
                  */
                 per_unit: string;
-                /**
-                 * Tier lower bound
-                 */
                 tier_lower_bound: string;
             }
         }
@@ -9032,13 +8843,7 @@ export declare namespace Price {
              * Configuration for a single tier
              */
             interface Tier {
-                /**
-                 * Minimum amount
-                 */
                 minimum_amount: string;
-                /**
-                 * Tier lower bound
-                 */
                 tier_lower_bound: string;
                 /**
                  * Per unit amount
@@ -9148,9 +8953,6 @@ export declare namespace Price {
              * Configuration for a single tier
              */
             interface Tier {
-                /**
-                 * Tier lower bound
-                 */
                 tier_lower_bound: string;
                 /**
                  * Per unit amount
@@ -9245,9 +9047,6 @@ export declare namespace Price {
          * Configuration for tiered_package_with_minimum pricing
          */
         interface TieredPackageWithMinimumConfig {
-            /**
-             * Package size
-             */
             package_size: number;
             /**
              * Apply tiered pricing after rounding up the quantity to the package size. Tiers
@@ -9260,17 +9059,8 @@ export declare namespace Price {
              * Configuration for a single tier
              */
             interface Tier {
-                /**
-                 * Minimum amount
-                 */
                 minimum_amount: string;
-                /**
-                 * Price per package
-                 */
                 per_unit: string;
-                /**
-                 * Tier lower bound
-                 */
                 tier_lower_bound: string;
             }
         }
@@ -9361,17 +9151,8 @@ export declare namespace Price {
          * Configuration for package_with_allocation pricing
          */
         interface PackageWithAllocationConfig {
-            /**
-             * Usage allocation
-             */
             allocation: string;
-            /**
-             * Price per package
-             */
             package_amount: string;
-            /**
-             * Package size
-             */
             package_size: string;
         }
     }
@@ -10179,22 +9960,13 @@ export declare namespace Price {
              * Configuration for a scaling factor
              */
             interface ScalingFactor {
-                /**
-                 * Scaling factor
-                 */
                 scaling_factor: string;
-                /**
-                 * Scaling value
-                 */
                 scaling_value: string;
             }
             /**
              * Configuration for a unit amount
              */
             interface UnitAmount {
-                /**
-                 * Pricing value
-                 */
                 pricing_value: string;
                 /**
                  * Per unit amount
@@ -10512,9 +10284,6 @@ export declare namespace Price {
              * The event property used to group before tiering
              */
             grouping_key: string;
-            /**
-             * Package size
-             */
             package_size: string;
             /**
              * Apply tiered pricing after rounding up the quantity to the package size. Tiers
@@ -10528,12 +10297,9 @@ export declare namespace Price {
              */
             interface Tier {
                 /**
-                 * Price per package
+                 * Per package
                  */
                 per_unit: string;
-                /**
-                 * Tier lower bound
-                 */
                 tier_lower_bound: string;
             }
         }
@@ -10628,9 +10394,6 @@ export declare namespace Price {
              * The event property used to group before tiering the group with the highest value
              */
             grouping_key: string;
-            /**
-             * Package size
-             */
             package_size: string;
             /**
              * Apply tiered pricing to the largest group after grouping with the provided key.
@@ -10642,9 +10405,6 @@ export declare namespace Price {
              * Configuration for a single tier
              */
             interface Tier {
-                /**
-                 * Tier lower bound
-                 */
                 tier_lower_bound: string;
                 /**
                  * Per unit amount
@@ -10765,17 +10525,8 @@ export declare namespace Price {
              * Configuration for a single matrix scaling factor
              */
             interface MatrixScalingFactor {
-                /**
-                 * First dimension value
-                 */
                 first_dimension_value: string;
-                /**
-                 * Scaling factor
-                 */
                 scaling_factor: string;
-                /**
-                 * Second dimension value (optional)
-                 */
                 second_dimension_value?: string | null;
             }
         }
@@ -10874,9 +10625,6 @@ export declare namespace Price {
              * Apply a scaling factor to each dimension
              */
             matrix_scaling_factors: Array<ScalableMatrixWithTieredPricingConfig.MatrixScalingFactor>;
-            /**
-             * Tier pricing structure
-             */
             tiers: Array<ScalableMatrixWithTieredPricingConfig.Tier>;
             /**
              * Used for the scalable matrix second dimension (optional)
@@ -10888,30 +10636,15 @@ export declare namespace Price {
              * Configuration for a single matrix scaling factor
              */
             interface MatrixScalingFactor {
-                /**
-                 * First dimension value
-                 */
                 first_dimension_value: string;
-                /**
-                 * Scaling factor
-                 */
                 scaling_factor: string;
-                /**
-                 * Second dimension value (optional)
-                 */
                 second_dimension_value?: string | null;
             }
             /**
              * Configuration for a single tier entry with business logic
              */
             interface Tier {
-                /**
-                 * Tier lower bound
-                 */
                 tier_lower_bound: string;
-                /**
-                 * Per unit amount
-                 */
                 unit_amount: string;
             }
         }
@@ -11006,9 +10739,6 @@ export declare namespace Price {
              * Each tier lower bound must have the same group of values.
              */
             dimension_values: Array<CumulativeGroupedBulkConfig.DimensionValue>;
-            /**
-             * Grouping key name
-             */
             group: string;
         }
         namespace CumulativeGroupedBulkConfig {
@@ -11185,13 +10915,13 @@ export declare namespace Price {
          */
         minimum_amount: string | null;
         /**
-         * Configuration for minimum pricing
+         * Configuration for minimum_composite pricing
          */
-        minimum_config: MinimumCompositePrice.MinimumConfig;
+        minimum_composite_config: MinimumCompositePrice.MinimumCompositeConfig;
         /**
          * The pricing model type
          */
-        model_type: 'minimum';
+        model_type: 'minimum_composite';
         name: string;
         plan_phase_order: number | null;
         price_type: 'usage_price' | 'fixed_price' | 'composite_price';
@@ -11218,9 +10948,9 @@ export declare namespace Price {
             values: Array<string>;
         }
         /**
-         * Configuration for minimum pricing
+         * Configuration for minimum_composite pricing
          */
-        interface MinimumConfig {
+        interface MinimumCompositeConfig {
             /**
              * The minimum amount to apply
              */