--- title: "Create plan version by external ID" method: POST path: "/plans/external_plan_id/{external_plan_id}/versions" tags: ["Plan"] --- # Create plan version by external ID `POST /plans/external_plan_id/{external_plan_id}/versions` This endpoint allows the creation of a new plan version for an existing plan. ## Path parameters - `external_plan_id` string, nullable, required ## Request body - NewPlanVersion - `add_prices` AddPlanPriceParams[], nullable — Additional prices to be added to the plan. - `price` union — New plan price request body params. - NewPlanUnitPrice - `model_type` 'unit', required — The pricing model type - `unit_config` UnitConfig, required — Configuration for unit pricing - `unit_amount` string, required — Rate per unit of usage - `prorated` boolean — If true, subtotals from this price are prorated based on the service period - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanTieredPrice - `model_type` 'tiered', required — The pricing model type - `tiered_config` TieredConfig, required — Configuration for tiered pricing - `tiers` Tier[], required — Tiers for rating based on total usage quantities into the specified tier - `first_unit` number, required — Exclusive tier starting value - `last_unit` number, nullable — Inclusive tier ending value. This value is null if and only if this is the last tier. - `unit_amount` string, required — Amount per unit - `prorated` boolean — If true, subtotals from this price are prorated based on the service period - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanBulkPrice - `model_type` 'bulk', required — The pricing model type - `bulk_config` BulkConfig, required — Configuration for bulk pricing - `tiers` BulkTier[], required — Bulk tiers for rating based on total usage volume - `maximum_units` number, nullable — Upper bound for this tier - `unit_amount` string, required — Amount per unit - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanBulkWithFiltersPrice - `model_type` 'bulk_with_filters', required — The pricing model type - `bulk_with_filters_config` BulkWithFiltersConfig, required — Bulk pricing with event filtering applies bulk pricing tiers based on total usage volume, but only charges for events that match specified property filters. How it works: 1. **Tier Selection**: Uses the customer's total usage quantity to determine which bulk pricing tier applies 2. **Event Filtering**: Only counts events where the specified property filters match (supports single or multiple filters) 3. **Billing**: Charges the filtered quantity at the rate determined by the total usage tier Example: - Total usage: 150 events - Bulk tiers: 0-99 = $1.00, 100+ = $0.80 - Filters: region="us-east-1" AND environment="production" - Filtered events: 75 events matching both filters - Result: 75 events × $0.80 = $60.00 (rate determined by 150 total, but only 75 charged) This allows customers to get bulk discounts based on their total volume while only paying for usage in specific regions, environments, or other filtered categories. - `tiers` BulkWithFiltersTier[], required — Bulk tiers for rating based on total usage volume - `tier_lower_bound` string, nullable — The lower bound for this tier - `unit_amount` string, required — Amount per unit - `filters` FilterRule[], required — Property filters to apply (all must match) - `property_key` string, required — Event property key to filter on - `property_value` string, required — Event property value to match - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanPackagePrice - `model_type` 'package', required — The pricing model type - `package_config` PackageConfig, required — Configuration for package pricing - `package_amount` string, required — A currency amount to rate usage by - `package_size` integer, required — An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanMatrixPrice - `model_type` 'matrix', required — The pricing model type - `matrix_config` MatrixConfig, required — Configuration for matrix pricing - `dimensions` string[], required — One or two event property values to evaluate matrix groups by - `default_unit_amount` string, required — Default per unit rate for any usage not bucketed into a specified matrix_value - `matrix_values` MatrixValue[], required — Matrix values configuration - `unit_amount` string, required — Unit price for the specified dimension_values - `dimension_values` string[], required — One or two matrix keys to filter usage to this Matrix value by - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanThresholdTotalAmountPrice - `model_type` 'threshold_total_amount', required — The pricing model type - `threshold_total_amount_config` ThresholdTotalAmountConfig, required — Configuration for tiered total pricing - `consumption_table` TieredTotalThreshold[], required — When the quantity consumed passes a provided threshold, the configured total will be charged - `threshold` string, required - `total_amount` string, required — Total amount for this threshold - `prorate` boolean, nullable — If true, the unit price will be prorated to the billing period - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanTieredPackagePrice - `model_type` 'tiered_package', required — The pricing model type - `tiered_package_config` TieredPackagePricingConfig, required — Configuration for tiered package pricing - `tiers` TieredPackageTierItem[], required — Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. The tier bounds are defined based on the total quantity rather than the number of packages, so they must be multiples of the package size. - `tier_lower_bound` string, required - `per_unit` string, required — Price per package - `package_size` string, required - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanTieredWithMinimumPrice - `model_type` 'tiered_with_minimum', required — The pricing model type - `tiered_with_minimum_config` TieredPricingWithMinimumConfig, required — Configuration for tiered pricing with minimum - `tiers` TieredPricingWithMinimumTierItem[], required — Tiered pricing with a minimum amount dependent on the volume tier. Tiers are defined using exclusive lower bounds. - `tier_lower_bound` string, required - `unit_amount` string, required — Per unit amount - `minimum_amount` string, required - `hide_zero_amount_tiers` boolean — If true, tiers with an accrued amount of 0 will not be included in the rating. - `prorate` boolean — If true, the unit price will be prorated to the billing period - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanGroupedTieredPrice - `model_type` 'grouped_tiered', required — The pricing model type - `grouped_tiered_config` GroupedTieredConfig, required — Configuration for grouped tiered pricing - `tiers` GroupedTieredTier[], required — Apply tiered pricing to each segment generated after grouping with the provided key - `tier_lower_bound` string, required - `unit_amount` string, required — Per unit amount - `grouping_key` string, required — The billable metric property used to group before tiering - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanTieredPackageWithMinimumPrice - `model_type` 'tiered_package_with_minimum', required — The pricing model type - `tiered_package_with_minimum_config` TieredPackagePricingWithMinimumConfig, required — Configuration for tiered package pricing with minimum - `tiers` TieredPackageWithMinimumTierItem[], required — Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. - `tier_lower_bound` string, required - `per_unit` string, required - `minimum_amount` string, required - `package_size` number, required - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanPackageWithAllocationPrice - `model_type` 'package_with_allocation', required — The pricing model type - `package_with_allocation_config` PackageWithAllocationConfig, required — Configuration for package pricing with usage allocation - `package_amount` string, required - `package_size` string, required - `allocation` string, required - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanUnitWithPercentPrice - `model_type` 'unit_with_percent', required — The pricing model type - `unit_with_percent_config` UnitWithPercentConfig, required — Configuration for unit pricing with percentage - `unit_amount` string, required — Rate per unit of usage - `percent` string, required — What percent, out of 100, of the calculated total to charge - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanMatrixWithAllocationPrice - `model_type` 'matrix_with_allocation', required — The pricing model type - `matrix_with_allocation_config` MatrixWithAllocationConfig, required — Configuration for matrix pricing with usage allocation - `dimensions` string[], required — One or two event property values to evaluate matrix groups by - `default_unit_amount` string, required — Default per unit rate for any usage not bucketed into a specified matrix_value - `allocation` string, required — Usage allocation - `matrix_values` MatrixWithAllocationValueItem[], required — Matrix values configuration - `unit_amount` string, required — Unit price for the specified dimension_values - `dimension_values` string[], required — One or two matrix keys to filter usage to this Matrix value by. For example, ["region", "tier"] could be used to filter cloud usage by a cloud region and an instance tier. - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanMatrixWithThresholdDiscountsPrice - `model_type` 'matrix_with_threshold_discounts', required — The pricing model type - `matrix_with_threshold_discounts_config` MatrixWithThresholdDiscountsConfig, required — Matrix pricing with per-dimension-subset threshold discounts. Each threshold-discount group targets a subset of matrix cells and applies a two-rate discount: a baseline % on spend at or below a threshold, and a steeper % on spend above. - `first_dimension` string, required — First matrix dimension key. - `second_dimension` string, nullable — Optional second matrix dimension key. - `default_unit_amount` string, required — Unit price used for usage that does not match any defined matrix cell. - `matrix_values` MatrixCell[], required — Per-cell unit prices. - `first_dimension_value` string, required - `second_dimension_value` string, nullable - `unit_amount` string, required - `threshold_discount_groups` ThresholdDiscountGroup[] - `description` string, nullable - `cell_coordinates` string, required — Semicolon-separated list of matrix cell coordinates targeted by this group. Each coordinate is `first,second` when the matrix has two dimensions, or just `first` for a single-dimension matrix. Example: `blue,circle;green,triangle`. - `threshold_amount` string, required - `below_threshold_discount_percentage` string, required — Discount rate applied to spend at or below the threshold. Set to 0 for no baseline discount. - `above_threshold_discount_percentage` string, required — Discount rate applied to spend above the threshold. - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanTieredWithProrationPrice - `model_type` 'tiered_with_proration', required — The pricing model type - `tiered_with_proration_config` TieredWithProrationConfig, required — Configuration for tiered pricing with proration - `tiers` TieredWithProrationTier[], required — Tiers for rating based on total usage quantities into the specified tier with proration - `tier_lower_bound` string, required — Inclusive tier starting value - `unit_amount` string, required — Amount per unit - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanUnitWithProrationPrice - `model_type` 'unit_with_proration', required — The pricing model type - `unit_with_proration_config` UnitWithProrationConfig, required — Configuration for unit pricing with proration - `unit_amount` string, required — Rate per unit of usage - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanGroupedAllocationPrice - `model_type` 'grouped_allocation', required — The pricing model type - `grouped_allocation_config` GroupedAllocationConfig, required — Configuration for grouped allocation pricing - `grouping_key` string, required — How to determine the groups that should each be allocated some quantity - `overage_unit_rate` string, required — Unit rate for post-allocation - `allocation` string, required — Usage allocation per group - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanBulkWithProrationPrice - `model_type` 'bulk_with_proration', required — The pricing model type - `bulk_with_proration_config` BulkWithProrationConfig, required — Configuration for bulk pricing with proration - `tiers` BulkTierWithProration[], required — Bulk tiers for rating based on total usage volume - `tier_lower_bound` string, nullable — The lower bound for this tier - `unit_amount` string, required — Cost per unit - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanGroupedWithProratedMinimumPrice - `model_type` 'grouped_with_prorated_minimum', required — The pricing model type - `grouped_with_prorated_minimum_config` GroupedWithProratedMinimumConfig, required — Configuration for grouped with prorated minimum pricing - `grouping_key` string, required — How to determine the groups that should each have a minimum - `unit_rate` string, required — The amount to charge per unit - `minimum` string, required — The minimum amount to charge per group - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanGroupedWithMeteredMinimumPrice - `model_type` 'grouped_with_metered_minimum', required — The pricing model type - `grouped_with_metered_minimum_config` GroupedWithMeteredMinimumConfig, required — Configuration for grouped with metered minimum pricing - `grouping_key` string, required — Used to partition the usage into groups. The minimum amount is applied to each group. - `pricing_key` string, required — Used to determine the unit rate - `scaling_key` string, required — Used to determine the unit rate scaling factor - `scaling_factors` GroupedWithMeteredMinimumScalingFactorItem[], required — Scale the unit rates by the scaling factor. - `scaling_value` string, required - `scaling_factor` string, required - `unit_amounts` GroupedWithMeteredMinimumUnitAmountItem[], required — Apply per unit pricing to each pricing value. The minimum amount is applied any unmatched usage. - `pricing_value` string, required - `unit_amount` string, required — Per unit amount - `minimum_unit_amount` string, required — The minimum amount to charge per group per unit - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanGroupedWithMinMaxThresholdsPrice - `model_type` 'grouped_with_min_max_thresholds', required — The pricing model type - `grouped_with_min_max_thresholds_config` GroupedWithMinMaxThresholdsConfig, required — Configuration for grouped with minimum and maximum thresholds pricing - `grouping_key` string, required — The event property used to group before applying thresholds - `per_unit_rate` string, required — The base price charged per group - `minimum_charge` string, required — The minimum amount to charge each group, regardless of usage - `maximum_charge` string, required — The maximum amount to charge each group - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanMatrixWithDisplayNamePrice - `model_type` 'matrix_with_display_name', required — The pricing model type - `matrix_with_display_name_config` MatrixWithDisplayNameConfig, required — Configuration for matrix with display name pricing - `dimension` string, required — Used to determine the unit rate - `unit_amounts` MatrixWithDisplayNameUnitAmountItem[], required — Apply per unit pricing to each dimension value - `display_name` string, required — Display name for this dimension value - `dimension_value` string, required — The dimension value - `unit_amount` string, required — Per unit amount - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanGroupedTieredPackagePrice - `model_type` 'grouped_tiered_package', required — The pricing model type - `grouped_tiered_package_config` GroupedTieredPackagePricingConfig, required — Configuration for grouped tiered package pricing - `tiers` GroupedTieredPackageTierItem[], required — Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. - `tier_lower_bound` string, required - `per_unit` string, required — Per package - `package_size` string, required - `grouping_key` string, required — The event property used to group before tiering - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanMaxGroupTieredPackagePrice - `model_type` 'max_group_tiered_package', required — The pricing model type - `max_group_tiered_package_config` MaxGroupTieredPackageConfig, required — Configuration for max group tiered package pricing - `tiers` MaxGroupTieredTierItem[], required — Apply tiered pricing to the largest group after grouping with the provided key. - `tier_lower_bound` string, required - `unit_amount` string, required — Per unit amount - `package_size` string, required - `grouping_key` string, required — The event property used to group before tiering the group with the highest value - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanScalableMatrixWithUnitPricingPrice - `model_type` 'scalable_matrix_with_unit_pricing', required — The pricing model type - `scalable_matrix_with_unit_pricing_config` ScalableMatrixWithUnitPricingConfig, required — Configuration for scalable matrix with unit pricing - `grouping_key` string, nullable — The property used to group this price - `unit_price` string, required — The final unit price to rate against the output of the matrix - `first_dimension` string, required — Used to determine the unit rate - `second_dimension` string, nullable — Used to determine the unit rate (optional) - `matrix_scaling_factors` ScalableMatrixWithUnitScalingFactor[], required — Apply a scaling factor to each dimension - `first_dimension_value` string, required - `second_dimension_value` string, nullable - `scaling_factor` string, required - `prorate` boolean, nullable — If true, the unit price will be prorated to the billing period - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanScalableMatrixWithTieredPricingPrice - `model_type` 'scalable_matrix_with_tiered_pricing', required — The pricing model type - `scalable_matrix_with_tiered_pricing_config` ScalableMatrixWithTieredPricingConfig, required — Configuration for scalable matrix with tiered pricing - `tiers` ScalableMatrixWithTieredTierEntry[], required - `tier_lower_bound` string, required - `unit_amount` string, required - `first_dimension` string, required — Used for the scalable matrix first dimension - `second_dimension` string, nullable — Used for the scalable matrix second dimension (optional) - `matrix_scaling_factors` ScalableMatrixWithTieredScalingFactor[], required — Apply a scaling factor to each dimension - `first_dimension_value` string, required - `second_dimension_value` string, nullable - `scaling_factor` string, required - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanCumulativeGroupedBulkPrice - `model_type` 'cumulative_grouped_bulk', required — The pricing model type - `cumulative_grouped_bulk_config` CumulativeGroupedBulkConfig, required — Configuration for cumulative grouped bulk pricing - `group` string, required - `dimension_values` CumulativeGroupedBulkDimensionValue[], required — Each tier lower bound must have the same group of values. - `tier_lower_bound` string, required — Tier lower bound - `grouping_key` string, required — Grouping key value - `unit_amount` string, required — Unit amount for this combination - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanCumulativeGroupedAllocationPrice - `model_type` 'cumulative_grouped_allocation', required — The pricing model type - `cumulative_grouped_allocation_config` CumulativeGroupedAllocationConfig, required — Configuration for cumulative grouped allocation pricing. This rating function groups usage by a grouping key and applies both per-group and cumulative allocations. For each group (ordered by group value), it calculates the larger of the group overage and the incremental cumulative overage. - `grouping_key` string, required — The event property used to group usage before applying allocations - `group_allocation` string, required — The allocation per individual group - `cumulative_allocation` string, required — The overall allocation across all groups - `unit_amount` string, required — The amount to charge for each unit outside of the allocation - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanDailyCreditAllowancePrice - `model_type` 'daily_credit_allowance', required — The pricing model type - `daily_credit_allowance_config` DailyCreditAllowanceConfig, required — Pricing model that gives a daily credit budget across one or more dimensional rates. Each event is rated in credits at a per-dimension `unit_amount`. Events are bucketed into days via an `event_day_property` set on the event (e.g. an ISO date string in the customer's timezone, supplied at ingest by the customer). Within each day the first `daily_allowance` credits are free; usage beyond that is charged in full. The allowance does not roll over. Use cases: shared daily AI-token budgets where different models have different credit costs. - `event_day_property` string, required — Event property whose value identifies the day bucket the event belongs to (e.g. 'event_day' set to an ISO date string in the customer's timezone). The allowance resets per distinct value of this property. - `dimensions` string[], required — One or two event property values to evaluate matrix groups by - `default_unit_amount` string, required — Default per-unit credit rate for any usage not bucketed into a specified matrix_value - `daily_allowance` string, required — Credits granted per day. Lose-it-or-use-it; does not roll over. - `matrix_values` DailyCreditAllowanceMatrixValue[], required — Per-dimension credit rates - `unit_amount` string, required — Credits charged per unit of usage matching the specified dimension_values - `dimension_values` string[], required — One or two matrix keys to filter usage to this value by. For example, ["model"] could be used to apply a different credit rate to each AI model. - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanMeteredAllowancePrice - `model_type` 'metered_allowance', required — The pricing model type - `metered_allowance_config` MeteredAllowanceConfig, required — Charges a per-unit rate on consumption above an allowance whose size is itself metered from usage in the same period. Both quantities come from a single billable metric, partitioned by `grouping_key`. The line item shows two sub-lines under one parent: the gross consumption row and a (negative) allowance credit row. The parent line equals the net charge, never negative — so adjustments, tax, prepaid credits, and rev rec all behave like any other usage line. Use cases: free egress proportional to bytes stored; free outbound bandwidth proportional to compute hours; free messages proportional to seat count; free output tokens proportional to input tokens. - `grouping_key` string, required — Event property used to partition the metric into consumption and allowance quantities (e.g. 'event_name'). The metric is queried with this key and the two values below select which partition is which. - `consumption_grouping_value` string, required — The grouping_key value whose summed quantity represents consumption (e.g. 'download'). Charged at unit_amount. - `allowance_grouping_value` string, required — The grouping_key value whose summed quantity represents the allowance for this period (e.g. 'storage_snapshot' emitting 3 × avg storage). Capped at consumption — credit can never exceed actual usage. - `unit_amount` string, required — Per-unit price applied to gross consumption and to the allowance credit. - `consumption_display_name` string — Sub-line label for the gross consumption row (e.g. 'bytes gotten'). - `allowance_display_name` string — Sub-line label for the credit row (e.g. 'Up to 3x free egress'). - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanMinimumCompositePrice - `model_type` 'minimum_composite', required — The pricing model type - `minimum_composite_config` MinimumCompositeConfig, required — Configuration for minimum composite price - `minimum_amount` string, required — The minimum amount to apply - `prorated` boolean — If true, subtotals from this price are prorated based on the service period - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanPercentCompositePrice - `model_type` 'percent', required — The pricing model type - `percent_config` PercentCompositeConfig, required — Configuration for a percent composite price. Charges ``percent`` of the sum of upstream subtotals matched by this price's composite filters. Optional ``minimum_amount`` and ``maximum_amount`` clamp the computed amount — leave both null for a pure pass-through percentage. Canonical bounded use case — service charge of the form "monthly fee = greater of X% of usage and $A, capped at $B": PercentCompositeConfig( percent=Decimal("0.08"), minimum_amount=MonetaryAmount(Decimal("5000")), maximum_amount=MonetaryAmount(Decimal("50000")), ) upstream sum $0 → fee $5,000 (minimum_amount) upstream sum $50,000 → fee $5,000 (minimum_amount; 8% = $4K < minimum_amount) upstream sum $100,000 → fee $8,000 (within bounds) upstream sum $1,000,000 → fee $50,000 (maximum_amount) - `percent` number, required — Fraction of the component subtotals to charge (0 < percent <= 1). - `minimum_amount` string, nullable — Minimum amount to charge. If unset, the fee is bounded below by 0. - `maximum_amount` string, nullable — Maximum amount to charge. If unset, the fee has no upper bound. - `prorated` boolean — If true, the minimum_amount is prorated based on the service period. The maximum_amount is an absolute cap (never prorated), and the percent applied to upstream subtotals is never prorated either. - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanEventOutputPrice - `model_type` 'event_output', required — The pricing model type - `event_output_config` EventOutputConfig, required - `unit_rating_key` string, required — The key in the event data to extract the unit rate from. - `grouping_key` string, nullable — An optional key in the event data to group by (e.g., event ID). All events will also be grouped by their unit rate. - `default_unit_rate` string, nullable — If provided, this amount will be used as the unit rate when an event does not have a value for the `unit_rating_key`. If not provided, events missing a unit rate will be ignored. - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - `allocation_price` NewAllocationPrice - `metadata` object, nullable — 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`. - `currency` string, required — An ISO 4217 currency string or a custom pricing unit identifier in which to bill this price. - `amount` string, required — An amount of the currency to allocate to the customer at the specified cadence. - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual', required — The cadence at which to allocate the amount to the customer. - `expires_at_end_of_cadence` boolean, nullable — Whether the allocated amount should expire at the end of the cadence or roll over to the next period. Set to null if using custom_expiration. - `custom_expiration` CustomExpiration - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` BlockPriceFilter[], nullable — The filters that determine which items the allocation applies to. - `field` 'item_id', required — The property of the price the block applies to. Only item_id is supported. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `per_unit_cost_basis` string — The (per-unit) cost basis of each created block. If non-zero, a customer will be invoiced according to the quantity and per unit cost basis specified for the allocation each cadence. - `item_id` string, nullable — The item ID that line items representing charges for this allocation will be associated with. If not provided, the default allocation item for the currency will be used (e.g. 'Included Allocation (USD)'). - `license_type_id` string, nullable — The license type ID to associate the price with license allocation. - `license_allocation_price` NewLicenseAllocationPrice - `model_type` 'unit', required — The pricing model type - `unit_config` UnitConfig, required — Configuration for unit pricing - `unit_amount` string, required — Rate per unit of usage - `prorated` boolean — If true, subtotals from this price are prorated based on the service period - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - `unit_amount` string, required — Amount per unit of overage - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - `tiers` ConversionRateTier[], required — Tiers for rating based on total usage quantities into the specified tier - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - `license_allocations` NewLicenseAllocation[], required — License allocations to associate with this price. Each entry defines a per-license credit pool granted each cadence. Requires license_type_id or license_type_configuration to be set. - `currency` string, required — The currency of the license allocation. - `amount` string, required — The amount of credits granted per active license per cadence. - `write_off_overage` boolean, nullable — When True, overage beyond the allocation is written off. - `plan_phase_order` integer, nullable — The phase to add this price to. - `remove_prices` RemovePlanPriceParams[], nullable — Prices to be removed from the plan. - `price_id` string, required — The id of the price to remove from the plan. - `plan_phase_order` integer, nullable — The phase to remove this price from. - `replace_prices` ReplacePlanPriceParams[], nullable — Prices to be replaced with additional prices on the plan. - `price` union — New plan price request body params. - NewPlanUnitPrice - `model_type` 'unit', required — The pricing model type - `unit_config` UnitConfig, required — Configuration for unit pricing - `unit_amount` string, required — Rate per unit of usage - `prorated` boolean — If true, subtotals from this price are prorated based on the service period - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanTieredPrice - `model_type` 'tiered', required — The pricing model type - `tiered_config` TieredConfig, required — Configuration for tiered pricing - `tiers` Tier[], required — Tiers for rating based on total usage quantities into the specified tier - `first_unit` number, required — Exclusive tier starting value - `last_unit` number, nullable — Inclusive tier ending value. This value is null if and only if this is the last tier. - `unit_amount` string, required — Amount per unit - `prorated` boolean — If true, subtotals from this price are prorated based on the service period - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanBulkPrice - `model_type` 'bulk', required — The pricing model type - `bulk_config` BulkConfig, required — Configuration for bulk pricing - `tiers` BulkTier[], required — Bulk tiers for rating based on total usage volume - `maximum_units` number, nullable — Upper bound for this tier - `unit_amount` string, required — Amount per unit - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanBulkWithFiltersPrice - `model_type` 'bulk_with_filters', required — The pricing model type - `bulk_with_filters_config` BulkWithFiltersConfig, required — Bulk pricing with event filtering applies bulk pricing tiers based on total usage volume, but only charges for events that match specified property filters. How it works: 1. **Tier Selection**: Uses the customer's total usage quantity to determine which bulk pricing tier applies 2. **Event Filtering**: Only counts events where the specified property filters match (supports single or multiple filters) 3. **Billing**: Charges the filtered quantity at the rate determined by the total usage tier Example: - Total usage: 150 events - Bulk tiers: 0-99 = $1.00, 100+ = $0.80 - Filters: region="us-east-1" AND environment="production" - Filtered events: 75 events matching both filters - Result: 75 events × $0.80 = $60.00 (rate determined by 150 total, but only 75 charged) This allows customers to get bulk discounts based on their total volume while only paying for usage in specific regions, environments, or other filtered categories. - `tiers` BulkWithFiltersTier[], required — Bulk tiers for rating based on total usage volume - `tier_lower_bound` string, nullable — The lower bound for this tier - `unit_amount` string, required — Amount per unit - `filters` FilterRule[], required — Property filters to apply (all must match) - `property_key` string, required — Event property key to filter on - `property_value` string, required — Event property value to match - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanPackagePrice - `model_type` 'package', required — The pricing model type - `package_config` PackageConfig, required — Configuration for package pricing - `package_amount` string, required — A currency amount to rate usage by - `package_size` integer, required — An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanMatrixPrice - `model_type` 'matrix', required — The pricing model type - `matrix_config` MatrixConfig, required — Configuration for matrix pricing - `dimensions` string[], required — One or two event property values to evaluate matrix groups by - `default_unit_amount` string, required — Default per unit rate for any usage not bucketed into a specified matrix_value - `matrix_values` MatrixValue[], required — Matrix values configuration - `unit_amount` string, required — Unit price for the specified dimension_values - `dimension_values` string[], required — One or two matrix keys to filter usage to this Matrix value by - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group - `license_type_id` string, nullable — The ID of the license type to associate with this price. - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based. - `item_id` string, required — The id of the item the price will be associated with. - `billed_in_advance` boolean, nullable — 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. - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied. - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on. - `billing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `invoicing_cycle_configuration` NewBillingCycleConfiguration - `duration` integer, required — The duration of the billing period. - `duration_unit` 'day' | 'month', required — The unit of billing period duration. - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency. - `conversion_rate_config` union - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed. - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call. - NewPlanThresholdTotalAmountPrice - `model_type` 'threshold_total_amount', required — The pricing model type - `threshold_total_amount_config` ThresholdTotalAmountConfig, required — Configuration for tiered total pricing - `consumption_table` TieredTotalThreshold[], required — When the quantity consumed passes a provided threshold, the configured total will be charged - `threshold` string, required - `total_amount` string, required — Total amount for this threshold - `prorate` boolean, nullable — If true, the unit price will be prorated to the billing period - `metadata` object, nullable — 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`. - `external_price_id` string, nullable — An alias for the price. - `name` string, required — The name of the price. - `dimensional_price_configuration` NewDimensionalPriceConfiguration - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in - … truncated; see the full OpenAPI document linked below ## Response `201` Created - PlanVersion — The PlanVersion resource represents the prices and adjustments present on a specific version of a plan. - `created_at` string, date-time, required - `version` integer, required - `plan_phases` PlanVersionPhase[], nullable, required - `id` string, required - `description` string, nullable, required - `duration` integer, nullable, required — How many terms of length `duration_unit` this phase is active for. If null, this phase is evergreen and active indefinitely - `duration_unit` 'daily' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual', nullable, required - `name` string, required - `order` integer, required — Determines the ordering of the phase in a plan's lifecycle. 1 = first phase. - `prices` Price[], required — Prices for this plan. If the plan has phases, this includes prices across all phases of the plan. - union — The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill. Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present. For more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price) - UnitPrice - `model_type` 'unit', required — The pricing model type - `unit_config` UnitConfig, required — Configuration for unit pricing - `unit_amount` string, required — Rate per unit of usage - `prorated` boolean — If true, subtotals from this price are prorated based on the service period - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - TieredPrice - `model_type` 'tiered', required — The pricing model type - `tiered_config` TieredConfig, required — Configuration for tiered pricing - `tiers` Tier[], required — Tiers for rating based on total usage quantities into the specified tier - `first_unit` number, required — Exclusive tier starting value - `last_unit` number, nullable — Inclusive tier ending value. This value is null if and only if this is the last tier. - `unit_amount` string, required — Amount per unit - `prorated` boolean — If true, subtotals from this price are prorated based on the service period - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - BulkPrice - `model_type` 'bulk', required — The pricing model type - `bulk_config` BulkConfig, required — Configuration for bulk pricing - `tiers` BulkTier[], required — Bulk tiers for rating based on total usage volume - `maximum_units` number, nullable — Upper bound for this tier - `unit_amount` string, required — Amount per unit - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - BulkWithFiltersPrice - `model_type` 'bulk_with_filters', required — The pricing model type - `bulk_with_filters_config` BulkWithFiltersConfig, required — Bulk pricing with event filtering applies bulk pricing tiers based on total usage volume, but only charges for events that match specified property filters. How it works: 1. **Tier Selection**: Uses the customer's total usage quantity to determine which bulk pricing tier applies 2. **Event Filtering**: Only counts events where the specified property filters match (supports single or multiple filters) 3. **Billing**: Charges the filtered quantity at the rate determined by the total usage tier Example: - Total usage: 150 events - Bulk tiers: 0-99 = $1.00, 100+ = $0.80 - Filters: region="us-east-1" AND environment="production" - Filtered events: 75 events matching both filters - Result: 75 events × $0.80 = $60.00 (rate determined by 150 total, but only 75 charged) This allows customers to get bulk discounts based on their total volume while only paying for usage in specific regions, environments, or other filtered categories. - `tiers` BulkWithFiltersTier[], required — Bulk tiers for rating based on total usage volume - `tier_lower_bound` string, nullable — The lower bound for this tier - `unit_amount` string, required — Amount per unit - `filters` FilterRule[], required — Property filters to apply (all must match) - `property_key` string, required — Event property key to filter on - `property_value` string, required — Event property value to match - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - PackagePrice - `model_type` 'package', required — The pricing model type - `package_config` PackageConfig, required — Configuration for package pricing - `package_amount` string, required — A currency amount to rate usage by - `package_size` integer, required — An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - MatrixPrice - `model_type` 'matrix', required — The pricing model type - `matrix_config` MatrixConfig, required — Configuration for matrix pricing - `dimensions` string[], required — One or two event property values to evaluate matrix groups by - `default_unit_amount` string, required — Default per unit rate for any usage not bucketed into a specified matrix_value - `matrix_values` MatrixValue[], required — Matrix values configuration - `unit_amount` string, required — Unit price for the specified dimension_values - `dimension_values` string[], required — One or two matrix keys to filter usage to this Matrix value by - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - ThresholdTotalAmountPrice - `model_type` 'threshold_total_amount', required — The pricing model type - `threshold_total_amount_config` ThresholdTotalAmountConfig, required — Configuration for tiered total pricing - `consumption_table` TieredTotalThreshold[], required — When the quantity consumed passes a provided threshold, the configured total will be charged - `threshold` string, required - `total_amount` string, required — Total amount for this threshold - `prorate` boolean, nullable — If true, the unit price will be prorated to the billing period - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - TieredPackagePrice - `model_type` 'tiered_package', required — The pricing model type - `tiered_package_config` TieredPackagePricingConfig, required — Configuration for tiered package pricing - `tiers` TieredPackageTierItem[], required — Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. The tier bounds are defined based on the total quantity rather than the number of packages, so they must be multiples of the package size. - `tier_lower_bound` string, required - `per_unit` string, required — Price per package - `package_size` string, required - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - TieredWithMinimumPrice - `model_type` 'tiered_with_minimum', required — The pricing model type - `tiered_with_minimum_config` TieredPricingWithMinimumConfig, required — Configuration for tiered pricing with minimum - `tiers` TieredPricingWithMinimumTierItem[], required — Tiered pricing with a minimum amount dependent on the volume tier. Tiers are defined using exclusive lower bounds. - `tier_lower_bound` string, required - `unit_amount` string, required — Per unit amount - `minimum_amount` string, required - `hide_zero_amount_tiers` boolean — If true, tiers with an accrued amount of 0 will not be included in the rating. - `prorate` boolean — If true, the unit price will be prorated to the billing period - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - GroupedTieredPrice - `model_type` 'grouped_tiered', required — The pricing model type - `grouped_tiered_config` GroupedTieredConfig, required — Configuration for grouped tiered pricing - `tiers` GroupedTieredTier[], required — Apply tiered pricing to each segment generated after grouping with the provided key - `tier_lower_bound` string, required - `unit_amount` string, required — Per unit amount - `grouping_key` string, required — The billable metric property used to group before tiering - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - TieredPackageWithMinimumPrice - `model_type` 'tiered_package_with_minimum', required — The pricing model type - `tiered_package_with_minimum_config` TieredPackagePricingWithMinimumConfig, required — Configuration for tiered package pricing with minimum - `tiers` TieredPackageWithMinimumTierItem[], required — Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. - `tier_lower_bound` string, required - `per_unit` string, required - `minimum_amount` string, required - `package_size` number, required - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - PackageWithAllocationPrice - `model_type` 'package_with_allocation', required — The pricing model type - `package_with_allocation_config` PackageWithAllocationConfig, required — Configuration for package pricing with usage allocation - `package_amount` string, required - `package_size` string, required - `allocation` string, required - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - UnitWithPercentPrice - `model_type` 'unit_with_percent', required — The pricing model type - `unit_with_percent_config` UnitWithPercentConfig, required — Configuration for unit pricing with percentage - `unit_amount` string, required — Rate per unit of usage - `percent` string, required — What percent, out of 100, of the calculated total to charge - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - MatrixWithAllocationPrice - `model_type` 'matrix_with_allocation', required — The pricing model type - `matrix_with_allocation_config` MatrixWithAllocationConfig, required — Configuration for matrix pricing with usage allocation - `dimensions` string[], required — One or two event property values to evaluate matrix groups by - `default_unit_amount` string, required — Default per unit rate for any usage not bucketed into a specified matrix_value - `allocation` string, required — Usage allocation - `matrix_values` MatrixWithAllocationValueItem[], required — Matrix values configuration - `unit_amount` string, required — Unit price for the specified dimension_values - `dimension_values` string[], required — One or two matrix keys to filter usage to this Matrix value by. For example, ["region", "tier"] could be used to filter cloud usage by a cloud region and an instance tier. - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - MatrixWithThresholdDiscountsPrice - `model_type` 'matrix_with_threshold_discounts', required — The pricing model type - `matrix_with_threshold_discounts_config` MatrixWithThresholdDiscountsConfig, required — Matrix pricing with per-dimension-subset threshold discounts. Each threshold-discount group targets a subset of matrix cells and applies a two-rate discount: a baseline % on spend at or below a threshold, and a steeper % on spend above. - `first_dimension` string, required — First matrix dimension key. - `second_dimension` string, nullable — Optional second matrix dimension key. - `default_unit_amount` string, required — Unit price used for usage that does not match any defined matrix cell. - `matrix_values` MatrixCell[], required — Per-cell unit prices. - `first_dimension_value` string, required - `second_dimension_value` string, nullable - `unit_amount` string, required - `threshold_discount_groups` ThresholdDiscountGroup[] - `description` string, nullable - `cell_coordinates` string, required — Semicolon-separated list of matrix cell coordinates targeted by this group. Each coordinate is `first,second` when the matrix has two dimensions, or just `first` for a single-dimension matrix. Example: `blue,circle;green,triangle`. - `threshold_amount` string, required - `below_threshold_discount_percentage` string, required — Discount rate applied to spend at or below the threshold. Set to 0 for no baseline discount. - `above_threshold_discount_percentage` string, required — Discount rate applied to spend above the threshold. - `metadata` object, required — 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`. - `id` string, required - `name` string, required - `external_price_id` string, nullable, required - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations. - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required - `created_at` string, date-time, required - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required - `billing_mode` 'in_advance' | 'in_arrear', required - `billing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `invoicing_cycle_configuration` BillingCycleConfiguration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `billable_metric` BillableMetricTiny, required - `id` string, required - `dimensional_price_configuration` DimensionalPriceConfiguration - `dimensional_price_group_id` string, required - `dimension_values` string[], required - `fixed_price_quantity` number, nullable, required - `plan_phase_order` integer, nullable, required - `currency` string, required - `conversion_rate` number, nullable, required - `conversion_rate_config` union, required - UnitConversionRateConfig - `conversion_rate_type` 'unit', required - `unit_config` ConversionRateUnitConfig, required - … - TieredConversionRateConfig - `conversion_rate_type` 'tiered', required - `tiered_config` ConversionRateTieredConfig, required - … - `item` ItemSlim, required — A minimal representation of an Item containing only the essential identifying information. - `id` string, required — The Orb-assigned unique identifier for the item. - `name` string, required — The name of the item. - `credit_allocation` Allocation, required - `currency` string, required - `allows_rollover` boolean, required - `custom_expiration` CustomExpiration, required - `duration` integer, required - `duration_unit` 'day' | 'month', required - `filters` PriceFilter[] - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `license_type_id` string, nullable - `composite_price_filters` PriceFilter[], nullable, required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `invoice_grouping_key` string, nullable, required - `license_type` LicenseType — The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key. - `id` string, required — The Orb-assigned unique identifier for the license type. - `name` string, required — The name of the license type. - `grouping_key` string, required — The key used for grouping licenses of this type. This is typically a user identifier field. - `discount` union, required - PercentageDiscount - `discount_type` 'percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1. - TrialDiscount - `discount_type` 'trial', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `trial_amount_discount` string, nullable — Only available if discount_type is `trial` - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial` - UsageDiscount - `discount_type` 'usage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for - AmountDiscount - `discount_type` 'amount', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `amount_discount` string, required — Only available if discount_type is `amount`. - TieredPercentageDiscount - `discount_type` 'tiered_percentage', required - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices. - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to. - … - `reason` string, nullable - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier). - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - … truncated; see the full OpenAPI document linked below ## Other responses - `400` — Bad Request - `401` — Unauthorized - `404` — Not Found - `409` — Conflict - `413` — Content Too Large - `429` — Too Many Requests - `500` — Internal Server Error --- [API](https://skmtc.dev/withorb/apis/api-reference.md) · [All operations](https://skmtc.dev/withorb/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/withorb/api-reference/revisions/816dfe734e2e/schema)