--- title: "Fetch subscription costs" method: GET path: "/subscriptions/{subscription_id}/costs" tags: ["Subscription"] --- # Fetch subscription costs `GET /subscriptions/{subscription_id}/costs` This endpoint is used to fetch a day-by-day snapshot of a subscription's costs in Orb, calculated by applying pricing information to the underlying usage (see the [subscription usage endpoint](fetch-subscription-usage) to fetch usage per metric, in usage units rather than a currency). The semantics of this endpoint exactly mirror those of [fetching a customer's costs](/api-reference/customer/fetch-customer-costs). Use this endpoint to limit your analysis of costs to a specific subscription for the customer (e.g. to de-aggregate costs when a customer's subscription has started and stopped on the same day). ## Path parameters - `subscription_id` string, required ## Query parameters - `timeframe_start` string, date-time, nullable — Costs returned are inclusive of `timeframe_start`. - `timeframe_end` string, date-time, nullable — Costs returned are exclusive of `timeframe_end`. - `view_mode` 'periodic' | 'cumulative', nullable — Controls whether Orb returns cumulative costs since the start of the billing period, or incremental day-by-day costs. If your customer has minimums or discounts, it's strongly recommended that you use the default cumulative behavior. - `currency` string, nullable — The currency or custom pricing unit to use. ## Response `200` OK - SubscriptionCosts - `data` AggregatedCost[], required - `subtotal` string, required — Total costs for the timeframe, excluding any minimums and discounts. - `total` string, required — Total costs for the timeframe, including any minimums and discounts. - `timeframe_start` string, date-time, required - `timeframe_end` string, date-time, required - `per_price_costs` PerPriceCost[], required - `quantity` number, nullable — The price's quantity for the timeframe - `subtotal` string, required — Price's contributions for the timeframe, excluding any minimums and discounts. - `total` string, required — Price's contributions for the timeframe, including minimums and discounts. - `price` union, required — 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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - … - `filters` FilterRule[], required — Property filters to apply (all must 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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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. - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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. - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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. - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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. - … - `threshold_discount_groups` ThresholdDiscountGroup[] - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - TieredWithProrationPrice - `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 - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - UnitWithProrationPrice - `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, 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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - GroupedAllocationPrice - `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, 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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - BulkWithProrationPrice - `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 - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - GroupedWithProratedMinimumPrice - `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, 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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - GroupedWithMeteredMinimumPrice - `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. - … - `unit_amounts` GroupedWithMeteredMinimumUnitAmountItem[], required — Apply per unit pricing to each pricing value. The minimum amount is applied any unmatched usage. - … - `minimum_unit_amount` string, required — The minimum amount to charge per group 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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - GroupedWithMinMaxThresholdsPrice - `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, 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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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 - … - TrialDiscount - … - UsageDiscount - … - AmountDiscount - … - TieredPercentageDiscount - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `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. - … - `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 - MatrixWithDisplayNamePrice - `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 - … - `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 - … - TieredConversionRateConfig - … - `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 - … - `filters` PriceFilter[] - … - `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. - … 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.net/withorb/apis/api-reference.md) · [All operations](https://skmtc.net/withorb/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/withorb/api-reference/versions/816dfe734e2e/schema)