orb-billing 5.31.0 → 5.33.0

package/src/resources/prices/prices.ts

@@ -281,6 +281,7 @@ export type PriceCreateParams =
   | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice
   | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice
   | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice
+  | PriceCreateParams.NewFloatingCumulativeGroupedAllocationPrice
   | PriceCreateParams.NewFloatingMinimumCompositePrice
   | PriceCreateParams.NewFloatingPercentCompositePrice
   | PriceCreateParams.NewFloatingEventOutputPrice;
@@ -3592,6 +3593,127 @@ export declare namespace PriceCreateParams {
     }
   }
 
+  export 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;
+  }
+
+  export namespace NewFloatingCumulativeGroupedAllocationPrice {
+    /**
+     * Configuration for cumulative_grouped_allocation pricing
+     */
+    export 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;
+    }
+  }
+
   export interface NewFloatingMinimumCompositePrice {
     /**
      * The cadence to bill for this price on.
@@ -4055,6 +4177,7 @@ export namespace PriceEvaluateMultipleParams {
       | Shared.NewFloatingScalableMatrixWithUnitPricingPrice
       | Shared.NewFloatingScalableMatrixWithTieredPricingPrice
       | Shared.NewFloatingCumulativeGroupedBulkPrice
+      | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice
       | Shared.NewFloatingMinimumCompositePrice
       | PriceEvaluation.NewFloatingPercentCompositePrice
       | PriceEvaluation.NewFloatingEventOutputPrice
@@ -4331,6 +4454,127 @@ export namespace PriceEvaluateMultipleParams {
       }
     }
 
+    export 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;
+    }
+
+    export namespace NewFloatingCumulativeGroupedAllocationPrice {
+      /**
+       * Configuration for cumulative_grouped_allocation pricing
+       */
+      export 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;
+      }
+    }
+
     export interface NewFloatingPercentCompositePrice {
       /**
        * The cadence to bill for this price on.
@@ -4673,6 +4917,7 @@ export namespace PriceEvaluatePreviewEventsParams {
       | Shared.NewFloatingScalableMatrixWithUnitPricingPrice
       | Shared.NewFloatingScalableMatrixWithTieredPricingPrice
       | Shared.NewFloatingCumulativeGroupedBulkPrice
+      | PriceEvaluation.NewFloatingCumulativeGroupedAllocationPrice
       | Shared.NewFloatingMinimumCompositePrice
       | PriceEvaluation.NewFloatingPercentCompositePrice
       | PriceEvaluation.NewFloatingEventOutputPrice
@@ -4949,6 +5194,127 @@ export namespace PriceEvaluatePreviewEventsParams {
       }
     }
 
+    export 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;
+    }
+
+    export namespace NewFloatingCumulativeGroupedAllocationPrice {
+      /**
+       * Configuration for cumulative_grouped_allocation pricing
+       */
+      export 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;
+      }
+    }
+
     export interface NewFloatingPercentCompositePrice {
       /**
        * The cadence to bill for this price on.

package/src/resources/shared.ts

@@ -9979,6 +9979,7 @@ export type Price =
   | Price.ScalableMatrixWithUnitPricingPrice
   | Price.ScalableMatrixWithTieredPricingPrice
   | Price.CumulativeGroupedBulkPrice
+  | Price.CumulativeGroupedAllocationPrice
   | Price.MinimumCompositePrice
   | Price.PercentCompositePrice
   | Price.EventOutputPrice;
@@ -13734,6 +13735,143 @@ export namespace Price {
     }
   }
 
+  export interface CumulativeGroupedAllocationPrice {
+    id: string;
+
+    billable_metric: Shared.BillableMetricTiny | null;
+
+    billing_cycle_configuration: Shared.BillingCycleConfiguration;
+
+    billing_mode: 'in_advance' | 'in_arrear';
+
+    cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
+
+    composite_price_filters: Array<CumulativeGroupedAllocationPrice.CompositePriceFilter> | null;
+
+    conversion_rate: number | null;
+
+    conversion_rate_config: Shared.UnitConversionRateConfig | Shared.TieredConversionRateConfig | null;
+
+    created_at: string;
+
+    credit_allocation: Shared.Allocation | null;
+
+    /**
+     * Configuration for cumulative_grouped_allocation pricing
+     */
+    cumulative_grouped_allocation_config: CumulativeGroupedAllocationPrice.CumulativeGroupedAllocationConfig;
+
+    currency: string;
+
+    /**
+     * @deprecated
+     */
+    discount: Shared.Discount | null;
+
+    external_price_id: string | null;
+
+    fixed_price_quantity: number | null;
+
+    invoicing_cycle_configuration: Shared.BillingCycleConfiguration | null;
+
+    /**
+     * A minimal representation of an Item containing only the essential identifying
+     * information.
+     */
+    item: Shared.ItemSlim;
+
+    /**
+     * @deprecated
+     */
+    maximum: Shared.Maximum | null;
+
+    /**
+     * @deprecated
+     */
+    maximum_amount: string | null;
+
+    /**
+     * User specified key-value pairs for the resource. If not present, this defaults
+     * to an empty dictionary. 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 };
+
+    /**
+     * @deprecated
+     */
+    minimum: Shared.Minimum | null;
+
+    /**
+     * @deprecated
+     */
+    minimum_amount: string | null;
+
+    /**
+     * The pricing model type
+     */
+    model_type: 'cumulative_grouped_allocation';
+
+    name: string;
+
+    plan_phase_order: number | null;
+
+    price_type: 'usage_price' | 'fixed_price' | 'composite_price';
+
+    /**
+     * The price id this price replaces. This price will take the place of the replaced
+     * price in plan version migrations.
+     */
+    replaces_price_id: string | null;
+
+    dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
+  }
+
+  export namespace CumulativeGroupedAllocationPrice {
+    export interface CompositePriceFilter {
+      /**
+       * The property of the price to filter on.
+       */
+      field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
+
+      /**
+       * Should prices that match the filter be included or excluded.
+       */
+      operator: 'includes' | 'excludes';
+
+      /**
+       * The IDs or values that match this filter.
+       */
+      values: Array<string>;
+    }
+
+    /**
+     * Configuration for cumulative_grouped_allocation pricing
+     */
+    export 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;
+    }
+  }
+
   export interface MinimumCompositePrice {
     id: string;