orb-billing 5.31.0 → 5.32.0

package/resources/shared.js.map

@@ -1 +1 @@
-{"version":3,"file":"shared.js","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAGtF,iDAAqC;AAoocrC,MAAa,eAAgB,SAAQ,iBAAgB;CAAG;AAAxD,0CAAwD;AAExD,MAAa,YAAa,SAAQ,iBAAa;CAAG;AAAlD,oCAAkD;AAElD,MAAa,UAAW,SAAQ,iBAAW;CAAG;AAA9C,gCAA8C"}
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAGtF,iDAAqC;AA8wcrC,MAAa,eAAgB,SAAQ,iBAAgB;CAAG;AAAxD,0CAAwD;AAExD,MAAa,YAAa,SAAQ,iBAAa;CAAG;AAAlD,oCAAkD;AAElD,MAAa,UAAW,SAAQ,iBAAW;CAAG;AAA9C,gCAA8C"}

package/resources/shared.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"shared.mjs","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,IAAI,EAAE;AAoocf,MAAM,OAAO,eAAgB,SAAQ,IAAgB;CAAG;AAExD,MAAM,OAAO,YAAa,SAAQ,IAAa;CAAG;AAElD,MAAM,OAAO,UAAW,SAAQ,IAAW;CAAG"}
+{"version":3,"file":"shared.mjs","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,IAAI,EAAE;AA8wcf,MAAM,OAAO,eAAgB,SAAQ,IAAgB;CAAG;AAExD,MAAM,OAAO,YAAa,SAAQ,IAAa;CAAG;AAElD,MAAM,OAAO,UAAW,SAAQ,IAAW;CAAG"}

package/resources/subscriptions.d.ts

@@ -4079,7 +4079,7 @@ export declare namespace SubscriptionCreateParams {
         /**
          * New subscription price request body params.
          */
-        price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | AddPrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | AddPrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | AddPrice.NewSubscriptionPercentCompositePrice | AddPrice.NewSubscriptionEventOutputPrice | null;
+        price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | AddPrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | AddPrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | AddPrice.NewSubscriptionCumulativeGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | AddPrice.NewSubscriptionPercentCompositePrice | AddPrice.NewSubscriptionEventOutputPrice | null;
         /**
          * The id of the price to add to the subscription.
          */
@@ -4440,6 +4440,114 @@ export declare namespace SubscriptionCreateParams {
                 per_unit_rate: string;
             }
         }
+        interface NewSubscriptionCumulativeGroupedAllocationPrice {
+            /**
+             * The cadence to bill for this price on.
+             */
+            cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+            /**
+             * Configuration for cumulative_grouped_allocation pricing
+             */
+            cumulative_grouped_allocation_config: NewSubscriptionCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
+            /**
+             * The id of the item the price will be associated with.
+             */
+            item_id: string;
+            /**
+             * The pricing model type
+             */
+            model_type: 'cumulative_grouped_allocation';
+            /**
+             * The name of the price.
+             */
+            name: string;
+            /**
+             * The id of the billable metric for the price. Only needed if the price is
+             * usage-based.
+             */
+            billable_metric_id?: string | null;
+            /**
+             * If the Price represents a fixed cost, the price will be billed in-advance if
+             * this is true, and in-arrears if this is false.
+             */
+            billed_in_advance?: boolean | null;
+            /**
+             * For custom cadence: specifies the duration of the billing period in days or
+             * months.
+             */
+            billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
+            /**
+             * The configuration for the rate of the price currency to the invoicing currency.
+             */
+            conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+            /**
+             * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+             * price is billed.
+             */
+            currency?: string | null;
+            /**
+             * For dimensional price: specifies a price group and dimension values
+             */
+            dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+            /**
+             * An alias for the price.
+             */
+            external_price_id?: string | null;
+            /**
+             * If the Price represents a fixed cost, this represents the quantity of units
+             * applied.
+             */
+            fixed_price_quantity?: number | null;
+            /**
+             * The property used to group this price on an invoice
+             */
+            invoice_grouping_key?: string | null;
+            /**
+             * Within each billing cycle, specifies the cadence at which invoices are produced.
+             * If unspecified, a single invoice is produced per billing cycle.
+             */
+            invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | 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?: {
+                [key: string]: string | null;
+            } | null;
+            /**
+             * A transient ID that can be used to reference this price when adding adjustments
+             * in the same API call.
+             */
+            reference_id?: string | null;
+        }
+        namespace NewSubscriptionCumulativeGroupedAllocationPrice {
+            /**
+             * Configuration for cumulative_grouped_allocation pricing
+             */
+            interface CumulativeGroupedAllocationConfig {
+                /**
+                 * The overall allocation across all groups
+                 */
+                cumulative_allocation: string;
+                /**
+                 * The allocation per individual group
+                 */
+                group_allocation: string;
+                /**
+                 * The event property used to group usage before applying allocations
+                 */
+                grouping_key: string;
+                /**
+                 * The amount to charge for each unit outside of the allocation
+                 */
+                unit_amount: string;
+            }
+        }
         interface NewSubscriptionPercentCompositePrice {
             /**
              * The cadence to bill for this price on.
@@ -4705,7 +4813,7 @@ export declare namespace SubscriptionCreateParams {
         /**
          * New subscription price request body params.
          */
-        price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | ReplacePrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | ReplacePrice.NewSubscriptionPercentCompositePrice | ReplacePrice.NewSubscriptionEventOutputPrice | null;
+        price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | ReplacePrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | ReplacePrice.NewSubscriptionCumulativeGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | ReplacePrice.NewSubscriptionPercentCompositePrice | ReplacePrice.NewSubscriptionEventOutputPrice | null;
         /**
          * The id of the price to add to the subscription.
          */
@@ -5060,6 +5168,114 @@ export declare namespace SubscriptionCreateParams {
                 per_unit_rate: string;
             }
         }
+        interface NewSubscriptionCumulativeGroupedAllocationPrice {
+            /**
+             * The cadence to bill for this price on.
+             */
+            cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+            /**
+             * Configuration for cumulative_grouped_allocation pricing
+             */
+            cumulative_grouped_allocation_config: NewSubscriptionCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
+            /**
+             * The id of the item the price will be associated with.
+             */
+            item_id: string;
+            /**
+             * The pricing model type
+             */
+            model_type: 'cumulative_grouped_allocation';
+            /**
+             * The name of the price.
+             */
+            name: string;
+            /**
+             * The id of the billable metric for the price. Only needed if the price is
+             * usage-based.
+             */
+            billable_metric_id?: string | null;
+            /**
+             * If the Price represents a fixed cost, the price will be billed in-advance if
+             * this is true, and in-arrears if this is false.
+             */
+            billed_in_advance?: boolean | null;
+            /**
+             * For custom cadence: specifies the duration of the billing period in days or
+             * months.
+             */
+            billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
+            /**
+             * The configuration for the rate of the price currency to the invoicing currency.
+             */
+            conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+            /**
+             * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+             * price is billed.
+             */
+            currency?: string | null;
+            /**
+             * For dimensional price: specifies a price group and dimension values
+             */
+            dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+            /**
+             * An alias for the price.
+             */
+            external_price_id?: string | null;
+            /**
+             * If the Price represents a fixed cost, this represents the quantity of units
+             * applied.
+             */
+            fixed_price_quantity?: number | null;
+            /**
+             * The property used to group this price on an invoice
+             */
+            invoice_grouping_key?: string | null;
+            /**
+             * Within each billing cycle, specifies the cadence at which invoices are produced.
+             * If unspecified, a single invoice is produced per billing cycle.
+             */
+            invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | 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?: {
+                [key: string]: string | null;
+            } | null;
+            /**
+             * A transient ID that can be used to reference this price when adding adjustments
+             * in the same API call.
+             */
+            reference_id?: string | null;
+        }
+        namespace NewSubscriptionCumulativeGroupedAllocationPrice {
+            /**
+             * Configuration for cumulative_grouped_allocation pricing
+             */
+            interface CumulativeGroupedAllocationConfig {
+                /**
+                 * The overall allocation across all groups
+                 */
+                cumulative_allocation: string;
+                /**
+                 * The allocation per individual group
+                 */
+                group_allocation: string;
+                /**
+                 * The event property used to group usage before applying allocations
+                 */
+                grouping_key: string;
+                /**
+                 * The amount to charge for each unit outside of the allocation
+                 */
+                unit_amount: string;
+            }
+        }
         interface NewSubscriptionPercentCompositePrice {
             /**
              * The cadence to bill for this price on.
@@ -5467,7 +5683,7 @@ export declare namespace SubscriptionPriceIntervalsParams {
         /**
          * New floating price request body params.
          */
-        price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Add.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Shared.NewFloatingMinimumCompositePrice | Add.NewFloatingPercentCompositePrice | Add.NewFloatingEventOutputPrice | null;
+        price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | Add.NewFloatingBulkWithFiltersPrice | Shared.NewFloatingPackagePrice | Shared.NewFloatingMatrixPrice | Shared.NewFloatingThresholdTotalAmountPrice | Shared.NewFloatingTieredPackagePrice | Shared.NewFloatingTieredWithMinimumPrice | Shared.NewFloatingGroupedTieredPrice | Shared.NewFloatingTieredPackageWithMinimumPrice | Shared.NewFloatingPackageWithAllocationPrice | Shared.NewFloatingUnitWithPercentPrice | Shared.NewFloatingMatrixWithAllocationPrice | Shared.NewFloatingTieredWithProrationPrice | Shared.NewFloatingUnitWithProrationPrice | Shared.NewFloatingGroupedAllocationPrice | Shared.NewFloatingBulkWithProrationPrice | Shared.NewFloatingGroupedWithProratedMinimumPrice | Shared.NewFloatingGroupedWithMeteredMinimumPrice | Add.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Add.NewFloatingCumulativeGroupedAllocationPrice | Shared.NewFloatingMinimumCompositePrice | Add.NewFloatingPercentCompositePrice | Add.NewFloatingEventOutputPrice | null;
         /**
          * The id of the price to add to the subscription.
          */
@@ -5740,6 +5956,108 @@ export declare namespace SubscriptionPriceIntervalsParams {
                 per_unit_rate: string;
             }
         }
+        interface NewFloatingCumulativeGroupedAllocationPrice {
+            /**
+             * The cadence to bill for this price on.
+             */
+            cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+            /**
+             * Configuration for cumulative_grouped_allocation pricing
+             */
+            cumulative_grouped_allocation_config: NewFloatingCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
+            /**
+             * An ISO 4217 currency string for which this price is billed in.
+             */
+            currency: string;
+            /**
+             * The id of the item the price will be associated with.
+             */
+            item_id: string;
+            /**
+             * The pricing model type
+             */
+            model_type: 'cumulative_grouped_allocation';
+            /**
+             * The name of the price.
+             */
+            name: string;
+            /**
+             * The id of the billable metric for the price. Only needed if the price is
+             * usage-based.
+             */
+            billable_metric_id?: string | null;
+            /**
+             * If the Price represents a fixed cost, the price will be billed in-advance if
+             * this is true, and in-arrears if this is false.
+             */
+            billed_in_advance?: boolean | null;
+            /**
+             * For custom cadence: specifies the duration of the billing period in days or
+             * months.
+             */
+            billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
+            /**
+             * The configuration for the rate of the price currency to the invoicing currency.
+             */
+            conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+            /**
+             * For dimensional price: specifies a price group and dimension values
+             */
+            dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+            /**
+             * An alias for the price.
+             */
+            external_price_id?: string | null;
+            /**
+             * If the Price represents a fixed cost, this represents the quantity of units
+             * applied.
+             */
+            fixed_price_quantity?: number | null;
+            /**
+             * The property used to group this price on an invoice
+             */
+            invoice_grouping_key?: string | null;
+            /**
+             * Within each billing cycle, specifies the cadence at which invoices are produced.
+             * If unspecified, a single invoice is produced per billing cycle.
+             */
+            invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | 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?: {
+                [key: string]: string | null;
+            } | null;
+        }
+        namespace NewFloatingCumulativeGroupedAllocationPrice {
+            /**
+             * Configuration for cumulative_grouped_allocation pricing
+             */
+            interface CumulativeGroupedAllocationConfig {
+                /**
+                 * The overall allocation across all groups
+                 */
+                cumulative_allocation: string;
+                /**
+                 * The allocation per individual group
+                 */
+                group_allocation: string;
+                /**
+                 * The event property used to group usage before applying allocations
+                 */
+                grouping_key: string;
+                /**
+                 * The amount to charge for each unit outside of the allocation
+                 */
+                unit_amount: string;
+            }
+        }
         interface NewFloatingPercentCompositePrice {
             /**
              * The cadence to bill for this price on.
@@ -6252,7 +6570,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         /**
          * New subscription price request body params.
          */
-        price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | AddPrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | AddPrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | AddPrice.NewSubscriptionPercentCompositePrice | AddPrice.NewSubscriptionEventOutputPrice | null;
+        price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | AddPrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | AddPrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | AddPrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | AddPrice.NewSubscriptionCumulativeGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | AddPrice.NewSubscriptionPercentCompositePrice | AddPrice.NewSubscriptionEventOutputPrice | null;
         /**
          * The id of the price to add to the subscription.
          */
@@ -6613,6 +6931,114 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
                 per_unit_rate: string;
             }
         }
+        interface NewSubscriptionCumulativeGroupedAllocationPrice {
+            /**
+             * The cadence to bill for this price on.
+             */
+            cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+            /**
+             * Configuration for cumulative_grouped_allocation pricing
+             */
+            cumulative_grouped_allocation_config: NewSubscriptionCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
+            /**
+             * The id of the item the price will be associated with.
+             */
+            item_id: string;
+            /**
+             * The pricing model type
+             */
+            model_type: 'cumulative_grouped_allocation';
+            /**
+             * The name of the price.
+             */
+            name: string;
+            /**
+             * The id of the billable metric for the price. Only needed if the price is
+             * usage-based.
+             */
+            billable_metric_id?: string | null;
+            /**
+             * If the Price represents a fixed cost, the price will be billed in-advance if
+             * this is true, and in-arrears if this is false.
+             */
+            billed_in_advance?: boolean | null;
+            /**
+             * For custom cadence: specifies the duration of the billing period in days or
+             * months.
+             */
+            billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
+            /**
+             * The configuration for the rate of the price currency to the invoicing currency.
+             */
+            conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+            /**
+             * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+             * price is billed.
+             */
+            currency?: string | null;
+            /**
+             * For dimensional price: specifies a price group and dimension values
+             */
+            dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+            /**
+             * An alias for the price.
+             */
+            external_price_id?: string | null;
+            /**
+             * If the Price represents a fixed cost, this represents the quantity of units
+             * applied.
+             */
+            fixed_price_quantity?: number | null;
+            /**
+             * The property used to group this price on an invoice
+             */
+            invoice_grouping_key?: string | null;
+            /**
+             * Within each billing cycle, specifies the cadence at which invoices are produced.
+             * If unspecified, a single invoice is produced per billing cycle.
+             */
+            invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | 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?: {
+                [key: string]: string | null;
+            } | null;
+            /**
+             * A transient ID that can be used to reference this price when adding adjustments
+             * in the same API call.
+             */
+            reference_id?: string | null;
+        }
+        namespace NewSubscriptionCumulativeGroupedAllocationPrice {
+            /**
+             * Configuration for cumulative_grouped_allocation pricing
+             */
+            interface CumulativeGroupedAllocationConfig {
+                /**
+                 * The overall allocation across all groups
+                 */
+                cumulative_allocation: string;
+                /**
+                 * The allocation per individual group
+                 */
+                group_allocation: string;
+                /**
+                 * The event property used to group usage before applying allocations
+                 */
+                grouping_key: string;
+                /**
+                 * The amount to charge for each unit outside of the allocation
+                 */
+                unit_amount: string;
+            }
+        }
         interface NewSubscriptionPercentCompositePrice {
             /**
              * The cadence to bill for this price on.
@@ -6878,7 +7304,7 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
         /**
          * New subscription price request body params.
          */
-        price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | ReplacePrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | ReplacePrice.NewSubscriptionPercentCompositePrice | ReplacePrice.NewSubscriptionEventOutputPrice | null;
+        price?: SubscriptionsAPI.NewSubscriptionUnitPrice | SubscriptionsAPI.NewSubscriptionTieredPrice | SubscriptionsAPI.NewSubscriptionBulkPrice | ReplacePrice.NewSubscriptionBulkWithFiltersPrice | SubscriptionsAPI.NewSubscriptionPackagePrice | SubscriptionsAPI.NewSubscriptionMatrixPrice | SubscriptionsAPI.NewSubscriptionThresholdTotalAmountPrice | SubscriptionsAPI.NewSubscriptionTieredPackagePrice | SubscriptionsAPI.NewSubscriptionTieredWithMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPrice | SubscriptionsAPI.NewSubscriptionTieredPackageWithMinimumPrice | SubscriptionsAPI.NewSubscriptionPackageWithAllocationPrice | SubscriptionsAPI.NewSubscriptionUnitWithPercentPrice | SubscriptionsAPI.NewSubscriptionMatrixWithAllocationPrice | ReplacePrice.NewSubscriptionTieredWithProrationPrice | SubscriptionsAPI.NewSubscriptionUnitWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionBulkWithProrationPrice | SubscriptionsAPI.NewSubscriptionGroupedWithProratedMinimumPrice | SubscriptionsAPI.NewSubscriptionGroupedWithMeteredMinimumPrice | ReplacePrice.NewSubscriptionGroupedWithMinMaxThresholdsPrice | SubscriptionsAPI.NewSubscriptionMatrixWithDisplayNamePrice | SubscriptionsAPI.NewSubscriptionGroupedTieredPackagePrice | SubscriptionsAPI.NewSubscriptionMaxGroupTieredPackagePrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithUnitPricingPrice | SubscriptionsAPI.NewSubscriptionScalableMatrixWithTieredPricingPrice | SubscriptionsAPI.NewSubscriptionCumulativeGroupedBulkPrice | ReplacePrice.NewSubscriptionCumulativeGroupedAllocationPrice | SubscriptionsAPI.NewSubscriptionMinimumCompositePrice | ReplacePrice.NewSubscriptionPercentCompositePrice | ReplacePrice.NewSubscriptionEventOutputPrice | null;
         /**
          * The id of the price to add to the subscription.
          */
@@ -7233,6 +7659,114 @@ export declare namespace SubscriptionSchedulePlanChangeParams {
                 per_unit_rate: string;
             }
         }
+        interface NewSubscriptionCumulativeGroupedAllocationPrice {
+            /**
+             * The cadence to bill for this price on.
+             */
+            cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+            /**
+             * Configuration for cumulative_grouped_allocation pricing
+             */
+            cumulative_grouped_allocation_config: NewSubscriptionCumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
+            /**
+             * The id of the item the price will be associated with.
+             */
+            item_id: string;
+            /**
+             * The pricing model type
+             */
+            model_type: 'cumulative_grouped_allocation';
+            /**
+             * The name of the price.
+             */
+            name: string;
+            /**
+             * The id of the billable metric for the price. Only needed if the price is
+             * usage-based.
+             */
+            billable_metric_id?: string | null;
+            /**
+             * If the Price represents a fixed cost, the price will be billed in-advance if
+             * this is true, and in-arrears if this is false.
+             */
+            billed_in_advance?: boolean | null;
+            /**
+             * For custom cadence: specifies the duration of the billing period in days or
+             * months.
+             */
+            billing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
+            /**
+             * The per unit conversion rate of the price currency to the invoicing currency.
+             */
+            conversion_rate?: number | null;
+            /**
+             * The configuration for the rate of the price currency to the invoicing currency.
+             */
+            conversion_rate_config?: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+            /**
+             * An ISO 4217 currency string, or custom pricing unit identifier, in which this
+             * price is billed.
+             */
+            currency?: string | null;
+            /**
+             * For dimensional price: specifies a price group and dimension values
+             */
+            dimensional_price_configuration?: Shared.NewDimensionalPriceConfiguration | null;
+            /**
+             * An alias for the price.
+             */
+            external_price_id?: string | null;
+            /**
+             * If the Price represents a fixed cost, this represents the quantity of units
+             * applied.
+             */
+            fixed_price_quantity?: number | null;
+            /**
+             * The property used to group this price on an invoice
+             */
+            invoice_grouping_key?: string | null;
+            /**
+             * Within each billing cycle, specifies the cadence at which invoices are produced.
+             * If unspecified, a single invoice is produced per billing cycle.
+             */
+            invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | 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?: {
+                [key: string]: string | null;
+            } | null;
+            /**
+             * A transient ID that can be used to reference this price when adding adjustments
+             * in the same API call.
+             */
+            reference_id?: string | null;
+        }
+        namespace NewSubscriptionCumulativeGroupedAllocationPrice {
+            /**
+             * Configuration for cumulative_grouped_allocation pricing
+             */
+            interface CumulativeGroupedAllocationConfig {
+                /**
+                 * The overall allocation across all groups
+                 */
+                cumulative_allocation: string;
+                /**
+                 * The allocation per individual group
+                 */
+                group_allocation: string;
+                /**
+                 * The event property used to group usage before applying allocations
+                 */
+                grouping_key: string;
+                /**
+                 * The amount to charge for each unit outside of the allocation
+                 */
+                unit_amount: string;
+            }
+        }
         interface NewSubscriptionPercentCompositePrice {
             /**
              * The cadence to bill for this price on.