orb-billing 5.17.0 → 5.18.0

package/resources/prices/prices.d.ts

@@ -190,7 +190,7 @@ export declare namespace PriceEvaluatePreviewEventsResponse {
         price_id?: string | null;
     }
 }
-export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMinMaxThresholdsPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice | PriceCreateParams.NewFloatingMinimumCompositePrice | PriceCreateParams.NewFloatingPercentCompositePrice | PriceCreateParams.NewFloatingEventOutputPrice;
+export type PriceCreateParams = PriceCreateParams.NewFloatingUnitPrice | PriceCreateParams.NewFloatingTieredPrice | PriceCreateParams.NewFloatingBulkPrice | PriceCreateParams.NewFloatingBulkWithFiltersPrice | PriceCreateParams.NewFloatingPackagePrice | PriceCreateParams.NewFloatingMatrixPrice | PriceCreateParams.NewFloatingThresholdTotalAmountPrice | PriceCreateParams.NewFloatingTieredPackagePrice | PriceCreateParams.NewFloatingTieredWithMinimumPrice | PriceCreateParams.NewFloatingGroupedTieredPrice | PriceCreateParams.NewFloatingTieredPackageWithMinimumPrice | PriceCreateParams.NewFloatingPackageWithAllocationPrice | PriceCreateParams.NewFloatingUnitWithPercentPrice | PriceCreateParams.NewFloatingMatrixWithAllocationPrice | PriceCreateParams.NewFloatingTieredWithProrationPrice | PriceCreateParams.NewFloatingUnitWithProrationPrice | PriceCreateParams.NewFloatingGroupedAllocationPrice | PriceCreateParams.NewFloatingBulkWithProrationPrice | PriceCreateParams.NewFloatingGroupedWithProratedMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMeteredMinimumPrice | PriceCreateParams.NewFloatingGroupedWithMinMaxThresholdsPrice | PriceCreateParams.NewFloatingMatrixWithDisplayNamePrice | PriceCreateParams.NewFloatingGroupedTieredPackagePrice | PriceCreateParams.NewFloatingMaxGroupTieredPackagePrice | PriceCreateParams.NewFloatingScalableMatrixWithUnitPricingPrice | PriceCreateParams.NewFloatingScalableMatrixWithTieredPricingPrice | PriceCreateParams.NewFloatingCumulativeGroupedBulkPrice | PriceCreateParams.NewFloatingMinimumCompositePrice | PriceCreateParams.NewFloatingPercentCompositePrice | PriceCreateParams.NewFloatingEventOutputPrice;
 export declare namespace PriceCreateParams {
     interface NewFloatingUnitPrice {
         /**
@@ -429,6 +429,128 @@ export declare namespace PriceCreateParams {
             [key: string]: string | null;
         } | null;
     }
+    interface NewFloatingBulkWithFiltersPrice {
+        /**
+         * Configuration for bulk_with_filters pricing
+         */
+        bulk_with_filters_config: NewFloatingBulkWithFiltersPrice.BulkWithFiltersConfig;
+        /**
+         * The cadence to bill for this price on.
+         */
+        cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+        /**
+         * 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: 'bulk_with_filters';
+        /**
+         * 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 NewFloatingBulkWithFiltersPrice {
+        /**
+         * Configuration for bulk_with_filters pricing
+         */
+        interface BulkWithFiltersConfig {
+            /**
+             * Property filters to apply (all must match)
+             */
+            filters: Array<BulkWithFiltersConfig.Filter>;
+            /**
+             * Bulk tiers for rating based on total usage volume
+             */
+            tiers: Array<BulkWithFiltersConfig.Tier>;
+        }
+        namespace BulkWithFiltersConfig {
+            /**
+             * Configuration for a single property filter
+             */
+            interface Filter {
+                /**
+                 * Event property key to filter on
+                 */
+                property_key: string;
+                /**
+                 * Event property value to match
+                 */
+                property_value: string;
+            }
+            /**
+             * Configuration for a single bulk pricing tier
+             */
+            interface Tier {
+                /**
+                 * Amount per unit
+                 */
+                unit_amount: string;
+                /**
+                 * The lower bound for this tier
+                 */
+                tier_lower_bound?: string | null;
+            }
+        }
+    }
     interface NewFloatingPackagePrice {
         /**
          * The cadence to bill for this price on.
@@ -3238,13 +3360,135 @@ export declare namespace PriceEvaluateMultipleParams {
         /**
          * New floating price request body params.
          */
-        price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | 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 | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
+        price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | PriceEvaluation.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 | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
         /**
          * The ID of a price to evaluate that exists in your Orb account.
          */
         price_id?: string | null;
     }
     namespace PriceEvaluation {
+        interface NewFloatingBulkWithFiltersPrice {
+            /**
+             * Configuration for bulk_with_filters pricing
+             */
+            bulk_with_filters_config: NewFloatingBulkWithFiltersPrice.BulkWithFiltersConfig;
+            /**
+             * The cadence to bill for this price on.
+             */
+            cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+            /**
+             * 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: 'bulk_with_filters';
+            /**
+             * 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 NewFloatingBulkWithFiltersPrice {
+            /**
+             * Configuration for bulk_with_filters pricing
+             */
+            interface BulkWithFiltersConfig {
+                /**
+                 * Property filters to apply (all must match)
+                 */
+                filters: Array<BulkWithFiltersConfig.Filter>;
+                /**
+                 * Bulk tiers for rating based on total usage volume
+                 */
+                tiers: Array<BulkWithFiltersConfig.Tier>;
+            }
+            namespace BulkWithFiltersConfig {
+                /**
+                 * Configuration for a single property filter
+                 */
+                interface Filter {
+                    /**
+                     * Event property key to filter on
+                     */
+                    property_key: string;
+                    /**
+                     * Event property value to match
+                     */
+                    property_value: string;
+                }
+                /**
+                 * Configuration for a single bulk pricing tier
+                 */
+                interface Tier {
+                    /**
+                     * Amount per unit
+                     */
+                    unit_amount: string;
+                    /**
+                     * The lower bound for this tier
+                     */
+                    tier_lower_bound?: string | null;
+                }
+            }
+        }
         interface NewFloatingGroupedWithMinMaxThresholdsPrice {
             /**
              * The cadence to bill for this price on.
@@ -3609,13 +3853,135 @@ export declare namespace PriceEvaluatePreviewEventsParams {
         /**
          * New floating price request body params.
          */
-        price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | 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 | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
+        price?: Shared.NewFloatingUnitPrice | Shared.NewFloatingTieredPrice | Shared.NewFloatingBulkPrice | PriceEvaluation.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 | PriceEvaluation.NewFloatingGroupedWithMinMaxThresholdsPrice | Shared.NewFloatingMatrixWithDisplayNamePrice | Shared.NewFloatingGroupedTieredPackagePrice | Shared.NewFloatingMaxGroupTieredPackagePrice | Shared.NewFloatingScalableMatrixWithUnitPricingPrice | Shared.NewFloatingScalableMatrixWithTieredPricingPrice | Shared.NewFloatingCumulativeGroupedBulkPrice | Shared.NewFloatingMinimumCompositePrice | PriceEvaluation.NewFloatingPercentCompositePrice | PriceEvaluation.NewFloatingEventOutputPrice | null;
         /**
          * The ID of a price to evaluate that exists in your Orb account.
          */
         price_id?: string | null;
     }
     namespace PriceEvaluation {
+        interface NewFloatingBulkWithFiltersPrice {
+            /**
+             * Configuration for bulk_with_filters pricing
+             */
+            bulk_with_filters_config: NewFloatingBulkWithFiltersPrice.BulkWithFiltersConfig;
+            /**
+             * The cadence to bill for this price on.
+             */
+            cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
+            /**
+             * 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: 'bulk_with_filters';
+            /**
+             * 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 NewFloatingBulkWithFiltersPrice {
+            /**
+             * Configuration for bulk_with_filters pricing
+             */
+            interface BulkWithFiltersConfig {
+                /**
+                 * Property filters to apply (all must match)
+                 */
+                filters: Array<BulkWithFiltersConfig.Filter>;
+                /**
+                 * Bulk tiers for rating based on total usage volume
+                 */
+                tiers: Array<BulkWithFiltersConfig.Tier>;
+            }
+            namespace BulkWithFiltersConfig {
+                /**
+                 * Configuration for a single property filter
+                 */
+                interface Filter {
+                    /**
+                     * Event property key to filter on
+                     */
+                    property_key: string;
+                    /**
+                     * Event property value to match
+                     */
+                    property_value: string;
+                }
+                /**
+                 * Configuration for a single bulk pricing tier
+                 */
+                interface Tier {
+                    /**
+                     * Amount per unit
+                     */
+                    unit_amount: string;
+                    /**
+                     * The lower bound for this tier
+                     */
+                    tier_lower_bound?: string | null;
+                }
+            }
+        }
         interface NewFloatingGroupedWithMinMaxThresholdsPrice {
             /**
              * The cadence to bill for this price on.