---
title: "Schedule plan change"
method: POST
path: "/subscriptions/{subscription_id}/schedule_plan_change"
tags: ["Subscription"]
---

# Schedule plan change

`POST /subscriptions/{subscription_id}/schedule_plan_change`

This endpoint can be used to change an existing subscription's plan. It returns the serialized updated subscription object.

The body parameter `change_option` determines when the plan change occurs. Orb supports three options:
- `end_of_subscription_term`: changes the plan at the end of the existing plan's term.
    - Issuing this plan change request for a monthly subscription will keep the existing plan active until the start
      of the subsequent month. Issuing this plan change request for a yearly subscription will keep the existing plan active for
      the full year. Charges incurred in the remaining period will be invoiced as normal.
    - Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, so the plan will be
      changed on February 1st, and invoice will be issued on February 1st for the last month of the original plan.
- `immediate`: changes the plan immediately.
    - Subscriptions that have their plan changed with this option will move to the new plan immediately, and be invoiced
      immediately.
    - This invoice will include any usage fees incurred in the billing period up to the change, along with any prorated
      recurring fees for the billing period, if applicable.
    - Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, so the plan will be
      changed on January 15th, and an invoice will be issued for the partial month, from January 1 to January 15, on the
      original plan.
- `requested_date`: changes the plan on the requested date (`change_date`).
    - If no timezone is provided, the customer's timezone is used. The `change_date` body parameter is required if this option
      is chosen.
    - Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, with a requested
      `change_date` of February 15th, so the plan will be changed on February 15th, and invoices will be issued on February 1st
      and February 15th.

Note that one of `plan_id` or `external_plan_id` is required in the request body for this operation.

## Customize your customer's subscriptions

Prices and adjustments in a plan can be added, removed, or replaced on the subscription when you schedule the plan change. This
is useful when a customer has prices that differ from the default prices for a specific plan.

<Note>
This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your
Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)
</Note>

### Adding Prices

To add prices, provide a list of objects with the key `add_prices`. An object in the list must specify an existing add-on price
with a `price_id` or `external_price_id` field, or create a new add-on price by including an object with the key `price`,
identical to what would be used in the request body for the [create price endpoint](/api-reference/price/create-price). See the
[Price resource](/product-catalog/price-configuration) for the specification of different price model configurations possible
in this object.

If the plan has phases, each object in the list must include a number with `plan_phase_order` key to indicate which phase the
price should be added to.

An object in the list can specify an optional `start_date` and optional `end_date`. If `start_date` is unspecified, the start
of the phase / plan change time will be used. If `end_date` is unspecified, it will finish at the end of the phase / have
no end time.

An object in the list can specify an optional `minimum_amount`, `maximum_amount`, or `discounts`. This will create adjustments
which apply only to this price.

Additionally, an object in the list can specify an optional `reference_id`. This ID can be used to reference this price when
[adding an adjustment](#adding-adjustments) in the same API call. However the ID is _transient_ and cannot be used to refer to
the price in future API calls.

### Removing Prices

To remove prices, provide a list of objects with the key `remove_prices`. An object in the list must specify a plan price with
either a `price_id` or `external_price_id` field.

### Replacing Prices

To replace prices, provide a list of objects with the key `replace_prices`. An object in the list must specify a plan price to
replace with the `replaces_price_id` key, and it must specify a price to replace it with by either referencing an existing
add-on price with a `price_id` or `external_price_id` field, or by creating a new add-on price by including an object with the
key `price`, identical to what would be used in the request body for
the [create price endpoint](/api-reference/price/create-price).
See the [Price resource](/product-catalog/price-configuration) for the specification of different price model configurations
possible in this object.

For fixed fees, an object in the list can supply a `fixed_price_quantity` instead of a `price`, `price_id`, or
`external_price_id` field. This will update only the quantity for the price, similar to the
[Update price quantity](/api-reference/subscription/update-price-quantity) endpoint.

The replacement price will have the same phase, if applicable, and the same start and end dates as the price it replaces.

An object in the list can specify an optional `minimum_amount`, `maximum_amount`, or `discounts`. This will create adjustments
which apply only to this price.

Additionally, an object in the list can specify an optional `reference_id`. This ID can be used to reference the replacement
price when [adding an adjustment](#adding-adjustments) in the same API call. However the ID is _transient_ and cannot be used to
refer to the price in future API calls.

### Adding adjustments

To add adjustments, provide a list of objects with the key `add_adjustments`. An object in the list must include an object with
the key `adjustment`, identical to the adjustment object in the
[add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).

If the plan has phases, each object in the list must include a number with `plan_phase_order` key to indicate which phase the
adjustment should be added to.

An object in the list can specify an optional `start_date` and optional `end_date`. If `start_date` is unspecified, the start
of the phase / plan change time will be used. If `end_date` is unspecified, it will finish at the end of the phase / have
no end time.

### Removing adjustments

To remove adjustments, provide a list of objects with the key `remove_adjustments`. An object in the list must include a key,
`adjustment_id`, with the ID of the adjustment to be removed.

### Replacing adjustments

To replace adjustments, provide a list of objects with the key `replace_adjustments`. An object in the list must specify a plan
adjustment to replace with the `replaces_adjustment_id` key, and it must specify an adjustment to replace it with by including
an object with the key `adjustment`, identical to the adjustment object in the
[add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).

The replacement adjustment will have the same phase, if applicable, and the same start and end dates as the adjustment it
replaces.

## Price overrides (DEPRECATED)

<Note>
Price overrides are being phased out in favor adding/removing/replacing prices. (See
[Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change))
</Note>

Price overrides are used to update some or all prices in a plan for the specific subscription being created. This is
useful when a new customer has negotiated a rate that is unique to the customer.

To override prices, provide a list of objects with the key `price_overrides`. The price object in the list of overrides
is expected to contain the existing price id, the `model_type` and configuration.
(See the [Price resource](/product-catalog/price-configuration)
for the specification of different price model configurations.) The numerical values can be updated, but the billable metric,
cadence, type, and name of a price can not be overridden.

### Maximums, and minimums
Price overrides are used to update some or all prices in the target plan. Minimums and maximums, much like price
overrides, can be useful when a new customer has negotiated a new or different minimum or maximum spend cap than the
default for the plan. The request format for maximums and minimums is the same as those in
[subscription creation](create-subscription).

## Scheduling multiple plan changes
When scheduling multiple plan changes with the same date, the latest plan change on that day takes effect.

## Prorations for in-advance fees
By default, Orb calculates the prorated difference in any fixed fees when making a plan change, adjusting the
customer balance as needed. For details on this behavior, see
[Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).

## Path parameters

- `subscription_id` string, required

## Request body

- SubscriptionPlanChange
  - `usage_customer_ids` string[], nullable — A list of customer IDs whose usage events will be aggregated and billed under this subscription. By default, a subscription only considers usage events associated with its attached customer's customer_id. When usage_customer_ids is provided, the subscription includes usage events from the specified customers only. Provided usage_customer_ids must be either the customer for this subscription itself, or any of that customer's children.
  - `filter` string, nullable — An additional filter to apply to usage queries. This filter must be expressed as a boolean [computed property](/extensibility/advanced-metrics#computed-properties). If null, usage queries will not include any additional filter.
  - `plan_id` string, nullable — The plan that the given subscription should be switched to. Note that either this property or `external_plan_id` must be specified.
  - `external_plan_id` string, nullable — The external_plan_id of the plan that the given subscription should be switched to. Note that either this property or `plan_id` must be specified.
  - `price_overrides` unknown[], nullable — Optionally provide a list of overrides for prices on the plan
    - unknown
  - `per_credit_overage_amount` number, nullable
  - `credits_overage_rate` number, nullable
  - `trial_duration_days` integer, nullable — The duration of the trial period in days. If not provided, this defaults to the value specified in the plan. If `0` is provided, the trial on the plan will be skipped.
  - `net_terms` integer, nullable — The net terms determines the difference between the invoice date and the issue date for the invoice. If you intend the invoice to be due on issue, set this to 0. If not provided, this defaults to the value specified in the plan.
  - `auto_collection` boolean, nullable — Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. If not specified, this defaults to the behavior configured for this customer.
  - `auto_issuance` boolean, nullable — Used to determine if invoices for this subscription will be automatically issued. If true, invoices will be automatically issued. If false, invoices will require manual approval. If `null` is specified, this defaults to the behavior configured for this customer.
  - `default_invoice_memo` string, nullable — Determines the default memo on this subscription's invoices. Note that if this is not provided, it is determined by the plan configuration.
  - `coupon_redemption_code` string, nullable — Redemption code to be used for this subscription. If the coupon cannot be found by its redemption code, or cannot be redeemed, an error response will be returned and the subscription creation or plan change will not be scheduled.
  - `invoicing_threshold` string, nullable — When this subscription's accrued usage reaches this threshold, an invoice will be issued for the subscription. If not specified, invoices will only be issued at the end of the billing period.
  - `initial_phase_order` integer, nullable — The phase of the plan to start with
  - `add_prices` AddSubscriptionPriceParams[], nullable — Additional prices to be added to the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)
    - `price_id` string, nullable — The id of the price to add to the subscription.
    - `external_price_id` string, nullable — The external price id of the price to add to the subscription.
    - `price` union — New subscription price request body params.
      - NewSubscriptionUnitPrice
        - `model_type` 'unit', required — The pricing model type
        - `unit_config` UnitConfig, required — Configuration for unit pricing
          - `unit_amount` string, required — Rate per unit of usage
          - `prorated` boolean — If true, subtotals from this price are prorated based on the service period
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionTieredPrice
        - `model_type` 'tiered', required — The pricing model type
        - `tiered_config` TieredConfig, required — Configuration for tiered pricing
          - `tiers` Tier[], required — Tiers for rating based on total usage quantities into the specified tier
            - `first_unit` number, required — Exclusive tier starting value
            - `last_unit` number, nullable — Inclusive tier ending value. This value is null if and only if this is the last tier.
            - `unit_amount` string, required — Amount per unit
          - `prorated` boolean — If true, subtotals from this price are prorated based on the service period
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionBulkPrice
        - `model_type` 'bulk', required — The pricing model type
        - `bulk_config` BulkConfig, required — Configuration for bulk pricing
          - `tiers` BulkTier[], required — Bulk tiers for rating based on total usage volume
            - `maximum_units` number, nullable — Upper bound for this tier
            - `unit_amount` string, required — Amount per unit
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionBulkWithFiltersPrice
        - `model_type` 'bulk_with_filters', required — The pricing model type
        - `bulk_with_filters_config` BulkWithFiltersConfig, required — Bulk pricing with event filtering applies bulk pricing tiers based on total usage volume, but only charges for events that match specified property filters. How it works: 1. **Tier Selection**: Uses the customer's total usage quantity to determine which bulk pricing tier applies 2. **Event Filtering**: Only counts events where the specified property filters match (supports single or multiple filters) 3. **Billing**: Charges the filtered quantity at the rate determined by the total usage tier Example: - Total usage: 150 events - Bulk tiers: 0-99 = $1.00, 100+ = $0.80 - Filters: region="us-east-1" AND environment="production" - Filtered events: 75 events matching both filters - Result: 75 events × $0.80 = $60.00 (rate determined by 150 total, but only 75 charged) This allows customers to get bulk discounts based on their total volume while only paying for usage in specific regions, environments, or other filtered categories.
          - `tiers` BulkWithFiltersTier[], required — Bulk tiers for rating based on total usage volume
            - `tier_lower_bound` string, nullable — The lower bound for this tier
            - `unit_amount` string, required — Amount per unit
          - `filters` FilterRule[], required — Property filters to apply (all must match)
            - `property_key` string, required — Event property key to filter on
            - `property_value` string, required — Event property value to match
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionPackagePrice
        - `model_type` 'package', required — The pricing model type
        - `package_config` PackageConfig, required — Configuration for package pricing
          - `package_amount` string, required — A currency amount to rate usage by
          - `package_size` integer, required — An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionMatrixPrice
        - `model_type` 'matrix', required — The pricing model type
        - `matrix_config` MatrixConfig, required — Configuration for matrix pricing
          - `dimensions` string[], required — One or two event property values to evaluate matrix groups by
          - `default_unit_amount` string, required — Default per unit rate for any usage not bucketed into a specified matrix_value
          - `matrix_values` MatrixValue[], required — Matrix values configuration
            - `unit_amount` string, required — Unit price for the specified dimension_values
            - `dimension_values` string[], required — One or two matrix keys to filter usage to this Matrix value by
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionThresholdTotalAmountPrice
        - `model_type` 'threshold_total_amount', required — The pricing model type
        - `threshold_total_amount_config` ThresholdTotalAmountConfig, required — Configuration for tiered total pricing
          - `consumption_table` TieredTotalThreshold[], required — When the quantity consumed passes a provided threshold, the configured total will be charged
            - `threshold` string, required
            - `total_amount` string, required — Total amount for this threshold
          - `prorate` boolean, nullable — If true, the unit price will be prorated to the billing period
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionTieredPackagePrice
        - `model_type` 'tiered_package', required — The pricing model type
        - `tiered_package_config` TieredPackagePricingConfig, required — Configuration for tiered package pricing
          - `tiers` TieredPackageTierItem[], required — Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. The tier bounds are defined based on the total quantity rather than the number of packages, so they must be multiples of the package size.
            - `tier_lower_bound` string, required
            - `per_unit` string, required — Price per package
          - `package_size` string, required
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionTieredWithMinimumPrice
        - `model_type` 'tiered_with_minimum', required — The pricing model type
        - `tiered_with_minimum_config` TieredPricingWithMinimumConfig, required — Configuration for tiered pricing with minimum
          - `tiers` TieredPricingWithMinimumTierItem[], required — Tiered pricing with a minimum amount dependent on the volume tier. Tiers are defined using exclusive lower bounds.
            - `tier_lower_bound` string, required
            - `unit_amount` string, required — Per unit amount
            - `minimum_amount` string, required
          - `hide_zero_amount_tiers` boolean — If true, tiers with an accrued amount of 0 will not be included in the rating.
          - `prorate` boolean — If true, the unit price will be prorated to the billing period
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionGroupedTieredPrice
        - `model_type` 'grouped_tiered', required — The pricing model type
        - `grouped_tiered_config` GroupedTieredConfig, required — Configuration for grouped tiered pricing
          - `tiers` GroupedTieredTier[], required — Apply tiered pricing to each segment generated after grouping with the provided key
            - `tier_lower_bound` string, required
            - `unit_amount` string, required — Per unit amount
          - `grouping_key` string, required — The billable metric property used to group before tiering
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionTieredPackageWithMinimumPrice
        - `model_type` 'tiered_package_with_minimum', required — The pricing model type
        - `tiered_package_with_minimum_config` TieredPackagePricingWithMinimumConfig, required — Configuration for tiered package pricing with minimum
          - `tiers` TieredPackageWithMinimumTierItem[], required — Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds.
            - `tier_lower_bound` string, required
            - `per_unit` string, required
            - `minimum_amount` string, required
          - `package_size` number, required
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionPackageWithAllocationPrice
        - `model_type` 'package_with_allocation', required — The pricing model type
        - `package_with_allocation_config` PackageWithAllocationConfig, required — Configuration for package pricing with usage allocation
          - `package_amount` string, required
          - `package_size` string, required
          - `allocation` string, required
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionUnitWithPercentPrice
        - `model_type` 'unit_with_percent', required — The pricing model type
        - `unit_with_percent_config` UnitWithPercentConfig, required — Configuration for unit pricing with percentage
          - `unit_amount` string, required — Rate per unit of usage
          - `percent` string, required — What percent, out of 100, of the calculated total to charge
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionMatrixWithAllocationPrice
        - `model_type` 'matrix_with_allocation', required — The pricing model type
        - `matrix_with_allocation_config` MatrixWithAllocationConfig, required — Configuration for matrix pricing with usage allocation
          - `dimensions` string[], required — One or two event property values to evaluate matrix groups by
          - `default_unit_amount` string, required — Default per unit rate for any usage not bucketed into a specified matrix_value
          - `allocation` string, required — Usage allocation
          - `matrix_values` MatrixWithAllocationValueItem[], required — Matrix values configuration
            - `unit_amount` string, required — Unit price for the specified dimension_values
            - `dimension_values` string[], required — One or two matrix keys to filter usage to this Matrix value by. For example, ["region", "tier"] could be used to filter cloud usage by a cloud region and an instance tier.
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionMatrixWithThresholdDiscountsPrice
        - `model_type` 'matrix_with_threshold_discounts', required — The pricing model type
        - `matrix_with_threshold_discounts_config` MatrixWithThresholdDiscountsConfig, required — Matrix pricing with per-dimension-subset threshold discounts. Each threshold-discount group targets a subset of matrix cells and applies a two-rate discount: a baseline % on spend at or below a threshold, and a steeper % on spend above.
          - `first_dimension` string, required — First matrix dimension key.
          - `second_dimension` string, nullable — Optional second matrix dimension key.
          - `default_unit_amount` string, required — Unit price used for usage that does not match any defined matrix cell.
          - `matrix_values` MatrixCell[], required — Per-cell unit prices.
            - `first_dimension_value` string, required
            - `second_dimension_value` string, nullable
            - `unit_amount` string, required
          - `threshold_discount_groups` ThresholdDiscountGroup[]
            - `description` string, nullable
            - `cell_coordinates` string, required — Semicolon-separated list of matrix cell coordinates targeted by this group. Each coordinate is `first,second` when the matrix has two dimensions, or just `first` for a single-dimension matrix. Example: `blue,circle;green,triangle`.
            - `threshold_amount` string, required
            - `below_threshold_discount_percentage` string, required — Discount rate applied to spend at or below the threshold. Set to 0 for no baseline discount.
            - `above_threshold_discount_percentage` string, required — Discount rate applied to spend above the threshold.
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionTieredWithProrationPrice
        - `model_type` 'tiered_with_proration', required — The pricing model type
        - `tiered_with_proration_config` TieredWithProrationConfig, required — Configuration for tiered pricing with proration
          - `tiers` TieredWithProrationTier[], required — Tiers for rating based on total usage quantities into the specified tier with proration
            - `tier_lower_bound` string, required — Inclusive tier starting value
            - `unit_amount` string, required — Amount per unit
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionUnitWithProrationPrice
        - `model_type` 'unit_with_proration', required — The pricing model type
        - `unit_with_proration_config` UnitWithProrationConfig, required — Configuration for unit pricing with proration
          - `unit_amount` string, required — Rate per unit of usage
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionGroupedAllocationPrice
        - `model_type` 'grouped_allocation', required — The pricing model type
        - `grouped_allocation_config` GroupedAllocationConfig, required — Configuration for grouped allocation pricing
          - `grouping_key` string, required — How to determine the groups that should each be allocated some quantity
          - `overage_unit_rate` string, required — Unit rate for post-allocation
          - `allocation` string, required — Usage allocation per group
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionBulkWithProrationPrice
        - `model_type` 'bulk_with_proration', required — The pricing model type
        - `bulk_with_proration_config` BulkWithProrationConfig, required — Configuration for bulk pricing with proration
          - `tiers` BulkTierWithProration[], required — Bulk tiers for rating based on total usage volume
            - `tier_lower_bound` string, nullable — The lower bound for this tier
            - `unit_amount` string, required — Cost per unit
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionGroupedWithProratedMinimumPrice
        - `model_type` 'grouped_with_prorated_minimum', required — The pricing model type
        - `grouped_with_prorated_minimum_config` GroupedWithProratedMinimumConfig, required — Configuration for grouped with prorated minimum pricing
          - `grouping_key` string, required — How to determine the groups that should each have a minimum
          - `unit_rate` string, required — The amount to charge per unit
          - `minimum` string, required — The minimum amount to charge per group
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionGroupedWithMeteredMinimumPrice
        - `model_type` 'grouped_with_metered_minimum', required — The pricing model type
        - `grouped_with_metered_minimum_config` GroupedWithMeteredMinimumConfig, required — Configuration for grouped with metered minimum pricing
          - `grouping_key` string, required — Used to partition the usage into groups. The minimum amount is applied to each group.
          - `pricing_key` string, required — Used to determine the unit rate
          - `scaling_key` string, required — Used to determine the unit rate scaling factor
          - `scaling_factors` GroupedWithMeteredMinimumScalingFactorItem[], required — Scale the unit rates by the scaling factor.
            - `scaling_value` string, required
            - `scaling_factor` string, required
          - `unit_amounts` GroupedWithMeteredMinimumUnitAmountItem[], required — Apply per unit pricing to each pricing value. The minimum amount is applied any unmatched usage.
            - `pricing_value` string, required
            - `unit_amount` string, required — Per unit amount
          - `minimum_unit_amount` string, required — The minimum amount to charge per group per unit
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionGroupedWithMinMaxThresholdsPrice
        - `model_type` 'grouped_with_min_max_thresholds', required — The pricing model type
        - `grouped_with_min_max_thresholds_config` GroupedWithMinMaxThresholdsConfig, required — Configuration for grouped with minimum and maximum thresholds pricing
          - `grouping_key` string, required — The event property used to group before applying thresholds
          - `per_unit_rate` string, required — The base price charged per group
          - `minimum_charge` string, required — The minimum amount to charge each group, regardless of usage
          - `maximum_charge` string, required — The maximum amount to charge each group
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionMatrixWithDisplayNamePrice
        - `model_type` 'matrix_with_display_name', required — The pricing model type
        - `matrix_with_display_name_config` MatrixWithDisplayNameConfig, required — Configuration for matrix with display name pricing
          - `dimension` string, required — Used to determine the unit rate
          - `unit_amounts` MatrixWithDisplayNameUnitAmountItem[], required — Apply per unit pricing to each dimension value
            - `display_name` string, required — Display name for this dimension value
            - `dimension_value` string, required — The dimension value
            - `unit_amount` string, required — Per unit amount
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionGroupedTieredPackagePrice
        - `model_type` 'grouped_tiered_package', required — The pricing model type
        - `grouped_tiered_package_config` GroupedTieredPackagePricingConfig, required — Configuration for grouped tiered package pricing
          - `tiers` GroupedTieredPackageTierItem[], required — Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds.
            - `tier_lower_bound` string, required
            - `per_unit` string, required — Per package
          - `package_size` string, required
          - `grouping_key` string, required — The event property used to group before tiering
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionMaxGroupTieredPackagePrice
        - `model_type` 'max_group_tiered_package', required — The pricing model type
        - `max_group_tiered_package_config` MaxGroupTieredPackageConfig, required — Configuration for max group tiered package pricing
          - `tiers` MaxGroupTieredTierItem[], required — Apply tiered pricing to the largest group after grouping with the provided key.
            - `tier_lower_bound` string, required
            - `unit_amount` string, required — Per unit amount
          - `package_size` string, required
          - `grouping_key` string, required — The event property used to group before tiering the group with the highest value
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionScalableMatrixWithUnitPricingPrice
        - `model_type` 'scalable_matrix_with_unit_pricing', required — The pricing model type
        - `scalable_matrix_with_unit_pricing_config` ScalableMatrixWithUnitPricingConfig, required — Configuration for scalable matrix with unit pricing
          - `grouping_key` string, nullable — The property used to group this price
          - `unit_price` string, required — The final unit price to rate against the output of the matrix
          - `first_dimension` string, required — Used to determine the unit rate
          - `second_dimension` string, nullable — Used to determine the unit rate (optional)
          - `matrix_scaling_factors` ScalableMatrixWithUnitScalingFactor[], required — Apply a scaling factor to each dimension
            - `first_dimension_value` string, required
            - `second_dimension_value` string, nullable
            - `scaling_factor` string, required
          - `prorate` boolean, nullable — If true, the unit price will be prorated to the billing period
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionScalableMatrixWithTieredPricingPrice
        - `model_type` 'scalable_matrix_with_tiered_pricing', required — The pricing model type
        - `scalable_matrix_with_tiered_pricing_config` ScalableMatrixWithTieredPricingConfig, required — Configuration for scalable matrix with tiered pricing
          - `tiers` ScalableMatrixWithTieredTierEntry[], required
            - `tier_lower_bound` string, required
            - `unit_amount` string, required
          - `first_dimension` string, required — Used for the scalable matrix first dimension
          - `second_dimension` string, nullable — Used for the scalable matrix second dimension (optional)
          - `matrix_scaling_factors` ScalableMatrixWithTieredScalingFactor[], required — Apply a scaling factor to each dimension
            - `first_dimension_value` string, required
            - `second_dimension_value` string, nullable
            - `scaling_factor` string, required
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionCumulativeGroupedBulkPrice
        - `model_type` 'cumulative_grouped_bulk', required — The pricing model type
        - `cumulative_grouped_bulk_config` CumulativeGroupedBulkConfig, required — Configuration for cumulative grouped bulk pricing
          - `group` string, required
          - `dimension_values` CumulativeGroupedBulkDimensionValue[], required — Each tier lower bound must have the same group of values.
            - `tier_lower_bound` string, required — Tier lower bound
            - `grouping_key` string, required — Grouping key value
            - `unit_amount` string, required — Unit amount for this combination
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionCumulativeGroupedAllocationPrice
        - `model_type` 'cumulative_grouped_allocation', required — The pricing model type
        - `cumulative_grouped_allocation_config` CumulativeGroupedAllocationConfig, required — Configuration for cumulative grouped allocation pricing. This rating function groups usage by a grouping key and applies both per-group and cumulative allocations. For each group (ordered by group value), it calculates the larger of the group overage and the incremental cumulative overage.
          - `grouping_key` string, required — The event property used to group usage before applying allocations
          - `group_allocation` string, required — The allocation per individual group
          - `cumulative_allocation` string, required — The overall allocation across all groups
          - `unit_amount` string, required — The amount to charge for each unit outside of the allocation
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionDailyCreditAllowancePrice
        - `model_type` 'daily_credit_allowance', required — The pricing model type
        - `daily_credit_allowance_config` DailyCreditAllowanceConfig, required — Pricing model that gives a daily credit budget across one or more dimensional rates. Each event is rated in credits at a per-dimension `unit_amount`. Events are bucketed into days via an `event_day_property` set on the event (e.g. an ISO date string in the customer's timezone, supplied at ingest by the customer). Within each day the first `daily_allowance` credits are free; usage beyond that is charged in full. The allowance does not roll over. Use cases: shared daily AI-token budgets where different models have different credit costs.
          - `event_day_property` string, required — Event property whose value identifies the day bucket the event belongs to (e.g. 'event_day' set to an ISO date string in the customer's timezone). The allowance resets per distinct value of this property.
          - `dimensions` string[], required — One or two event property values to evaluate matrix groups by
          - `default_unit_amount` string, required — Default per-unit credit rate for any usage not bucketed into a specified matrix_value
          - `daily_allowance` string, required — Credits granted per day. Lose-it-or-use-it; does not roll over.
          - `matrix_values` DailyCreditAllowanceMatrixValue[], required — Per-dimension credit rates
            - `unit_amount` string, required — Credits charged per unit of usage matching the specified dimension_values
            - `dimension_values` string[], required — One or two matrix keys to filter usage to this value by. For example, ["model"] could be used to apply a different credit rate to each AI model.
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionMeteredAllowancePrice
        - `model_type` 'metered_allowance', required — The pricing model type
        - `metered_allowance_config` MeteredAllowanceConfig, required — Charges a per-unit rate on consumption above an allowance whose size is itself metered from usage in the same period. Both quantities come from a single billable metric, partitioned by `grouping_key`. The line item shows two sub-lines under one parent: the gross consumption row and a (negative) allowance credit row. The parent line equals the net charge, never negative — so adjustments, tax, prepaid credits, and rev rec all behave like any other usage line. Use cases: free egress proportional to bytes stored; free outbound bandwidth proportional to compute hours; free messages proportional to seat count; free output tokens proportional to input tokens.
          - `grouping_key` string, required — Event property used to partition the metric into consumption and allowance quantities (e.g. 'event_name'). The metric is queried with this key and the two values below select which partition is which.
          - `consumption_grouping_value` string, required — The grouping_key value whose summed quantity represents consumption (e.g. 'download'). Charged at unit_amount.
          - `allowance_grouping_value` string, required — The grouping_key value whose summed quantity represents the allowance for this period (e.g. 'storage_snapshot' emitting 3 × avg storage). Capped at consumption — credit can never exceed actual usage.
          - `unit_amount` string, required — Per-unit price applied to gross consumption and to the allowance credit.
          - `consumption_display_name` string — Sub-line label for the gross consumption row (e.g. 'bytes gotten').
          - `allowance_display_name` string — Sub-line label for the credit row (e.g. 'Up to 3x free egress').
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionMinimumCompositePrice
        - `model_type` 'minimum_composite', required — The pricing model type
        - `minimum_composite_config` MinimumCompositeConfig, required — Configuration for minimum composite price
          - `minimum_amount` string, required — The minimum amount to apply
          - `prorated` boolean — If true, subtotals from this price are prorated based on the service period
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionPercentCompositePrice
        - `model_type` 'percent', required — The pricing model type
        - `percent_config` PercentCompositeConfig, required — Configuration for a percent composite price. Charges ``percent`` of the sum of upstream subtotals matched by this price's composite filters. Optional ``minimum_amount`` and ``maximum_amount`` clamp the computed amount — leave both null for a pure pass-through percentage. Canonical bounded use case — service charge of the form "monthly fee = greater of X% of usage and $A, capped at $B": PercentCompositeConfig( percent=Decimal("0.08"), minimum_amount=MonetaryAmount(Decimal("5000")), maximum_amount=MonetaryAmount(Decimal("50000")), ) upstream sum $0 → fee $5,000 (minimum_amount) upstream sum $50,000 → fee $5,000 (minimum_amount; 8% = $4K < minimum_amount) upstream sum $100,000 → fee $8,000 (within bounds) upstream sum $1,000,000 → fee $50,000 (maximum_amount)
          - `percent` number, required — Fraction of the component subtotals to charge (0 < percent <= 1).
          - `minimum_amount` string, nullable — Minimum amount to charge. If unset, the fee is bounded below by 0.
          - `maximum_amount` string, nullable — Maximum amount to charge. If unset, the fee has no upper bound.
          - `prorated` boolean — If true, the minimum_amount is prorated based on the service period. The maximum_amount is an absolute cap (never prorated), and the percent applied to upstream subtotals is never prorated either.
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionEventOutputPrice
        - `model_type` 'event_output', required — The pricing model type
        - `event_output_config` EventOutputConfig, required
          - `unit_rating_key` string, required — The key in the event data to extract the unit rate from.
          - `grouping_key` string, nullable — An optional key in the event data to group by (e.g., event ID). All events will also be grouped by their unit rate.
          - `default_unit_rate` string, nullable — If provided, this amount will be used as the unit rate when an event does not have a value for the `unit_rating_key`. If not provided, events missing a unit rate will be ignored.
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
    - `allocation_price` NewAllocationPrice
      - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
      - `currency` string, required — An ISO 4217 currency string or a custom pricing unit identifier in which to bill this price.
      - `amount` string, required — An amount of the currency to allocate to the customer at the specified cadence.
      - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual', required — The cadence at which to allocate the amount to the customer.
      - `expires_at_end_of_cadence` boolean, nullable — Whether the allocated amount should expire at the end of the cadence or roll over to the next period. Set to null if using custom_expiration.
      - `custom_expiration` CustomExpiration
        - `duration` integer, required
        - `duration_unit` 'day' | 'month', required
      - `filters` BlockPriceFilter[], nullable — The filters that determine which items the allocation applies to.
        - `field` 'item_id', required — The property of the price the block applies to. Only item_id is supported.
        - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded.
        - `values` string[], required — The IDs or values that match this filter.
      - `per_unit_cost_basis` string — The (per-unit) cost basis of each created block. If non-zero, a customer will be invoiced according to the quantity and per unit cost basis specified for the allocation each cadence.
      - `item_id` string, nullable — The item ID that line items representing charges for this allocation will be associated with. If not provided, the default allocation item for the currency will be used (e.g. 'Included Allocation (USD)').
      - `license_type_id` string, nullable — The license type ID to associate the price with license allocation.
    - `start_date` string, date-time, nullable — The start date of the price interval. This is the date that the price will start billing on the subscription. If null, billing will start when the phase or subscription starts.
    - `end_date` string, date-time, nullable — The end date of the price interval. This is the date that the price will stop billing on the subscription. If null, billing will end when the phase or subscription ends.
    - `plan_phase_order` integer, nullable — The phase to add this price to.
    - `minimum_amount` string, nullable — [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for this price.
    - `maximum_amount` string, nullable — [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for this price.
    - `discounts` DiscountOverride[], nullable — [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this price.
      - `discount_type` 'percentage' | 'usage' | 'amount', required
      - `percentage_discount` number, nullable — Only available if discount_type is `percentage`. This is a number between 0 and 1.
      - `usage_discount` number, nullable — Only available if discount_type is `usage`. Number of usage units that this discount is for
      - `amount_discount` string, nullable — Only available if discount_type is `amount`.
    - `metric_parameter_overrides` object, nullable — Override values for parameterized billable metric variables. Keys are parameter names, values are the override values.
  - `remove_prices` RemoveSubscriptionPriceParams[], nullable — Plan prices to be removed from the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)
    - `price_id` string, nullable — The id of the price to remove on the subscription.
    - `external_price_id` string, nullable — The external price id of the price to remove on the subscription.
  - `replace_prices` ReplaceSubscriptionPriceParams[], nullable — Plan prices to be replaced with additional prices on the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)
    - `price_id` string, nullable — The id of the price to add to the subscription.
    - `external_price_id` string, nullable — The external price id of the price to add to the subscription.
    - `price` union — New subscription price request body params.
      - NewSubscriptionUnitPrice
        - `model_type` 'unit', required — The pricing model type
        - `unit_config` UnitConfig, required — Configuration for unit pricing
          - `unit_amount` string, required — Rate per unit of usage
          - `prorated` boolean — If true, subtotals from this price are prorated based on the service period
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionTieredPrice
        - `model_type` 'tiered', required — The pricing model type
        - `tiered_config` TieredConfig, required — Configuration for tiered pricing
          - `tiers` Tier[], required — Tiers for rating based on total usage quantities into the specified tier
            - `first_unit` number, required — Exclusive tier starting value
            - `last_unit` number, nullable — Inclusive tier ending value. This value is null if and only if this is the last tier.
            - `unit_amount` string, required — Amount per unit
          - `prorated` boolean — If true, subtotals from this price are prorated based on the service period
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionBulkPrice
        - `model_type` 'bulk', required — The pricing model type
        - `bulk_config` BulkConfig, required — Configuration for bulk pricing
          - `tiers` BulkTier[], required — Bulk tiers for rating based on total usage volume
            - `maximum_units` number, nullable — Upper bound for this tier
            - `unit_amount` string, required — Amount per unit
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionBulkWithFiltersPrice
        - `model_type` 'bulk_with_filters', required — The pricing model type
        - `bulk_with_filters_config` BulkWithFiltersConfig, required — Bulk pricing with event filtering applies bulk pricing tiers based on total usage volume, but only charges for events that match specified property filters. How it works: 1. **Tier Selection**: Uses the customer's total usage quantity to determine which bulk pricing tier applies 2. **Event Filtering**: Only counts events where the specified property filters match (supports single or multiple filters) 3. **Billing**: Charges the filtered quantity at the rate determined by the total usage tier Example: - Total usage: 150 events - Bulk tiers: 0-99 = $1.00, 100+ = $0.80 - Filters: region="us-east-1" AND environment="production" - Filtered events: 75 events matching both filters - Result: 75 events × $0.80 = $60.00 (rate determined by 150 total, but only 75 charged) This allows customers to get bulk discounts based on their total volume while only paying for usage in specific regions, environments, or other filtered categories.
          - `tiers` BulkWithFiltersTier[], required — Bulk tiers for rating based on total usage volume
            - `tier_lower_bound` string, nullable — The lower bound for this tier
            - `unit_amount` string, required — Amount per unit
          - `filters` FilterRule[], required — Property filters to apply (all must match)
            - `property_key` string, required — Event property key to filter on
            - `property_value` string, required — Event property value to match
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionPackagePrice
        - `model_type` 'package', required — The pricing model type
        - `package_config` PackageConfig, required — Configuration for package pricing
          - `package_amount` string, required — A currency amount to rate usage by
          - `package_size` integer, required — An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionMatrixPrice
        - `model_type` 'matrix', required — The pricing model type
        - `matrix_config` MatrixConfig, required — Configuration for matrix pricing
          - `dimensions` string[], required — One or two event property values to evaluate matrix groups by
          - `default_unit_amount` string, required — Default per unit rate for any usage not bucketed into a specified matrix_value
          - `matrix_values` MatrixValue[], required — Matrix values configuration
            - `unit_amount` string, required — Unit price for the specified dimension_values
            - `dimension_values` string[], required — One or two matrix keys to filter usage to this Matrix value by
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
          - UnitConversionRateConfig
            - `conversion_rate_type` 'unit', required
            - `unit_config` ConversionRateUnitConfig, required
              - …
          - TieredConversionRateConfig
            - `conversion_rate_type` 'tiered', required
            - `tiered_config` ConversionRateTieredConfig, required
              - …
        - `currency` string, nullable — An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.
        - `reference_id` string, nullable — A transient ID that can be used to reference this price when adding adjustments in the same API call.
      - NewSubscriptionThresholdTotalAmountPrice
        - `model_type` 'threshold_total_amount', required — The pricing model type
        - `threshold_total_amount_config` ThresholdTotalAmountConfig, required — Configuration for tiered total pricing
          - `consumption_table` TieredTotalThreshold[], required — When the quantity consumed passes a provided threshold, the configured total will be charged
            - `threshold` string, required
            - `total_amount` string, required — Total amount for this threshold
          - `prorate` boolean, nullable — If true, the unit price will be prorated to the billing period
        - `metadata` object, nullable — User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
        - `external_price_id` string, nullable — An alias for the price.
        - `name` string, required — The name of the price.
        - `dimensional_price_configuration` NewDimensionalPriceConfiguration
          - `dimensional_price_group_id` string, nullable — The id of the dimensional price group to include this price in
          - `external_dimensional_price_group_id` string, nullable — The external id of the dimensional price group to include this price in
          - `dimension_values` string[], required — The list of dimension values matching (in order) the dimensions of the price group
        - `license_type_id` string, nullable — The ID of the license type to associate with this price.
        - `billable_metric_id` string, nullable — The id of the billable metric for the price. Only needed if the price is usage-based.
        - `item_id` string, required — The id of the item the price will be associated with.
        - `billed_in_advance` boolean, nullable — If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false.
        - `fixed_price_quantity` number, nullable — If the Price represents a fixed cost, this represents the quantity of units applied.
        - `invoice_grouping_key` string, nullable — The property used to group this price on an invoice
        - `cadence` 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom', required — The cadence to bill for this price on.
        - `billing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `invoicing_cycle_configuration` NewBillingCycleConfiguration
          - `duration` integer, required — The duration of the billing period.
          - `duration_unit` 'day' | 'month', required — The unit of billing period duration.
        - `conversion_rate` number, nullable — The per unit conversion rate of the price currency to the invoicing currency.
        - `conversion_rate_config` union
- … truncated; see the full OpenAPI document linked below

## Response `200`

OK

- MutatedSubscription
  - `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
  - `customer` Customer, required — A customer is a buyer of your products, and the other party to the billing relationship. In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an `external_customer_id` with your own identifier. See [Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these aliases work in Orb. In addition to having an identifier in your system, a customer may exist in a payment provider solution like Stripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping. A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which defaults to your account's timezone. See [Timezone localization](/essentials/timezones) for information on what this timezone parameter influences within Orb.
    - `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
    - `external_customer_id` string, nullable, required — An optional user-defined ID for this customer resource, used throughout the system as an alias for this Customer. Use this field to identify a customer by an existing identifier in your system.
    - `name` string, required — The full name of the customer
    - `email` string, required — A valid customer email, to be used for notifications. When Orb triggers payment through a payment gateway, this email will be used for any automatically issued receipts.
    - `timezone` string, required — A timezone identifier from the IANA timezone database, such as "America/Los_Angeles". This "defaults to your account's timezone if not set. This cannot be changed after customer creation.
    - `payment_provider_id` string, nullable, required — The ID of this customer in an external payments solution, such as Stripe. This is used for creating charges or invoices in the external system via Orb.
    - `payment_provider` 'quickbooks' | 'bill.com' | 'stripe_charge' | 'stripe_invoice' | 'netsuite' | 'adyen', nullable, required — This is used for creating charges or invoices in an external system via Orb. When not in test mode, the connection must first be configured in the Orb webapp.
    - `created_at` string, date-time, required
    - `shipping_address` Address, required
      - `line1` string, nullable, required
      - `line2` string, nullable, required
      - `city` string, nullable, required
      - `state` string, nullable, required
      - `postal_code` string, nullable, required
      - `country` string, nullable, required
    - `billing_address` Address, required
      - `line1` string, nullable, required
      - `line2` string, nullable, required
      - `city` string, nullable, required
      - `state` string, nullable, required
      - `postal_code` string, nullable, required
      - `country` string, nullable, required
    - `balance` string, required — The customer's current balance in their currency.
    - `currency` string, nullable, required
    - `tax_id` CustomerTaxId, required — Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices. ### Supported Tax ID Countries and Types | Country | Type | Description | |---------|------|-------------| | Albania | `al_tin` | Albania Tax Identification Number | | Andorra | `ad_nrt` | Andorran NRT Number | | Angola | `ao_tin` | Angola Tax Identification Number | | Argentina | `ar_cuit` | Argentinian Tax ID Number | | Armenia | `am_tin` | Armenia Tax Identification Number | | Aruba | `aw_tin` | Aruba Tax Identification Number | | Australia | `au_abn` | Australian Business Number (AU ABN) | | Australia | `au_arn` | Australian Taxation Office Reference Number | | Austria | `eu_vat` | European VAT Number | | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number | | Bahamas | `bs_tin` | Bahamas Tax Identification Number | | Bahrain | `bh_vat` | Bahraini VAT Number | | Bangladesh | `bd_bin` | Bangladesh Business Identification Number | | Barbados | `bb_tin` | Barbados Tax Identification Number | | Belarus | `by_tin` | Belarus TIN Number | | Belgium | `eu_vat` | European VAT Number | | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) | | Bolivia | `bo_tin` | Bolivian Tax ID | | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number | | Brazil | `br_cnpj` | Brazilian CNPJ Number | | Brazil | `br_cpf` | Brazilian CPF Number | | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | | Bulgaria | `eu_vat` | European VAT Number | | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) | | Cambodia | `kh_tin` | Cambodia Tax Identification Number | | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) | | Canada | `ca_bn` | Canadian BN | | Canada | `ca_gst_hst` | Canadian GST/HST Number | | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | | Canada | `ca_qst` | Canadian QST Number (Québec) | | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) | | Chile | `cl_tin` | Chilean TIN | | China | `cn_tin` | Chinese Tax ID | | Colombia | `co_nit` | Colombian NIT Number | | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) | | Costa Rica | `cr_tin` | Costa Rican Tax ID | | Croatia | `eu_vat` | European VAT Number | | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) | | Cyprus | `eu_vat` | European VAT Number | | Czech Republic | `eu_vat` | European VAT Number | | Denmark | `eu_vat` | European VAT Number | | Dominican Republic | `do_rcn` | Dominican RCN Number | | Ecuador | `ec_ruc` | Ecuadorian RUC Number | | Egypt | `eg_tin` | Egyptian Tax Identification Number | | El Salvador | `sv_nit` | El Salvadorian NIT Number | | Estonia | `eu_vat` | European VAT Number | | Ethiopia | `et_tin` | Ethiopia Tax Identification Number | | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | | Faroe Islands | `fo_vat` | Faroe Islands VAT Number | | Finland | `eu_vat` | European VAT Number | | France | `eu_vat` | European VAT Number | | Georgia | `ge_vat` | Georgian VAT | | Germany | `de_stn` | German Tax Number (Steuernummer) | | Germany | `eu_vat` | European VAT Number | | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number | | Greece | `eu_vat` | European VAT Number | | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) | | Hong Kong | `hk_br` | Hong Kong BR Number | | Hungary | `eu_vat` | European VAT Number | | Hungary | `hu_tin` | Hungary Tax Number (adószám) | | Iceland | `is_vat` | Icelandic VAT | | India | `in_gst` | Indian GST Number | | Indonesia | `id_npwp` | Indonesian NPWP Number | | Ireland | `eu_vat` | European VAT Number | | Israel | `il_vat` | Israel VAT | | Italy | `eu_vat` | European VAT Number | | Italy | `it_cf` | Italian Codice Fiscale Number | | Japan | `jp_cn` | Japanese Corporate Number (*Hōjin Bangō*) | | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (*Tōroku Kokugai Jigyōsha no Tōroku Bangō*) | | Japan | `jp_trn` | Japanese Tax Registration Number (*Tōroku Bangō*) | | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number | | Laos | `la_tin` | Laos Tax Identification Number | | Latvia | `eu_vat` | European VAT Number | | Liechtenstein | `li_uid` | Liechtensteinian UID Number | | Liechtenstein | `li_vat` | Liechtenstein VAT Number | | Lithuania | `eu_vat` | European VAT Number | | Luxembourg | `eu_vat` | European VAT Number | | Malaysia | `my_frp` | Malaysian FRP Number | | Malaysia | `my_itn` | Malaysian ITN | | Malaysia | `my_sst` | Malaysian SST Number | | Malta | `eu_vat` | European VAT Number | | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) | | Mexico | `mx_rfc` | Mexican RFC Number | | Moldova | `md_vat` | Moldova VAT Number | | Montenegro | `me_pib` | Montenegro PIB Number | | Morocco | `ma_vat` | Morocco VAT Number | | Nepal | `np_pan` | Nepal PAN Number | | Netherlands | `eu_vat` | European VAT Number | | New Zealand | `nz_gst` | New Zealand GST Number | | Nigeria | `ng_tin` | Nigerian Tax Identification Number | | North Macedonia | `mk_vat` | North Macedonia VAT Number | | Northern Ireland | `eu_vat` | Northern Ireland VAT Number | | Norway | `no_vat` | Norwegian VAT Number | | Norway | `no_voec` | Norwegian VAT on e-commerce Number | | Oman | `om_vat` | Omani VAT Number | | Paraguay | `py_ruc` | Paraguayan RUC Number | | Peru | `pe_ruc` | Peruvian RUC Number | | Philippines | `ph_tin` | Philippines Tax Identification Number | | Poland | `eu_vat` | European VAT Number | | Poland | `pl_nip` | Polish Tax ID Number | | Portugal | `eu_vat` | European VAT Number | | Romania | `eu_vat` | European VAT Number | | Romania | `ro_tin` | Romanian Tax ID Number | | Russia | `ru_inn` | Russian INN | | Russia | `ru_kpp` | Russian KPP | | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | | Senegal | `sn_ninea` | Senegal NINEA Number | | Serbia | `rs_pib` | Serbian PIB Number | | Singapore | `sg_gst` | Singaporean GST | | Singapore | `sg_uen` | Singaporean UEN | | Slovakia | `eu_vat` | European VAT Number | | Slovenia | `eu_vat` | European VAT Number | | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | | South Africa | `za_vat` | South African VAT Number | | South Korea | `kr_brn` | Korean BRN | | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | | Spain | `eu_vat` | European VAT Number | | Sri Lanka | `lk_vat` | Sri Lanka VAT Number | | Suriname | `sr_fin` | Suriname FIN Number | | Sweden | `eu_vat` | European VAT Number | | Switzerland | `ch_uid` | Switzerland UID Number | | Switzerland | `ch_vat` | Switzerland VAT Number | | Taiwan | `tw_vat` | Taiwanese VAT | | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number | | Tanzania | `tz_vat` | Tanzania VAT Number | | Thailand | `th_vat` | Thai VAT | | Turkey | `tr_tin` | Turkish Tax Identification Number | | Uganda | `ug_tin` | Uganda Tax Identification Number | | Ukraine | `ua_vat` | Ukrainian VAT | | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | | United Kingdom | `gb_vat` | United Kingdom VAT Number | | United States | `us_ein` | United States EIN | | Uruguay | `uy_ruc` | Uruguayan RUC Number | | Uzbekistan | `uz_tin` | Uzbekistan TIN Number | | Uzbekistan | `uz_vat` | Uzbekistan VAT Number | | Venezuela | `ve_rif` | Venezuelan RIF Number | | Vietnam | `vn_tin` | Vietnamese Tax ID Number | | Zambia | `zm_tin` | Zambia Tax Identification Number | | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
      - `country` 'AD' | 'AE' | 'AL' | 'AM' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BJ' | 'BO' | 'BR' | 'BS' | 'BY' | 'CA' | 'CD' | 'CH' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CY' | 'CZ' | 'DE' | 'DK' | 'DO' | 'EC' | 'EE' | 'EG' | 'ES' | 'ET' | 'EU' | 'FI' | 'FO' | 'FR' | 'GB' | 'GE' | 'GI' | 'GN' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KG' | 'KH' | 'KR' | 'KZ' | 'LA' | 'LI' | 'LK' | 'LT' | 'LU' | 'LV' | 'MA' | 'MD' | 'ME' | 'MK' | 'MR' | 'MT' | 'MX' | 'MY' | 'NG' | 'NL' | 'NO' | 'NP' | 'NZ' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'PY' | 'RO' | 'RS' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SN' | 'SR' | 'SV' | 'TH' | 'TJ' | 'TR' | 'TW' | 'TZ' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VE' | 'VN' | 'ZA' | 'ZM' | 'ZW', required
      - `type` 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin', required
      - `value` string, required
    - `auto_collection` boolean, required
    - `exempt_from_automated_tax` boolean, nullable, required
    - `email_delivery` boolean, required
    - `auto_issuance` boolean, nullable, required — Whether invoices for this customer should be automatically issued. If true, invoices will be automatically issued. If false, invoices will require manual approval. If null, inherits the account-level setting.
    - `additional_emails` string[], required
    - `portal_url` string, nullable, required — Deprecated. Returns the URL of the most recent non-expired portal link, or null. When the account has opted into customer portal sessions, this field always returns null. Use POST /v1/customers/{id}/portal_sessions to mint short-lived portal session URLs.
    - `accounting_sync_configuration` AccountingSyncConfiguration
      - `excluded` boolean, required
      - `accounting_providers` AccountingProvider[], required
        - `provider_type` 'quickbooks' | 'netsuite', required
        - `external_provider_id` string, nullable, required
    - `reporting_configuration` ReportingConfiguration
      - `exempt` boolean, required
    - `payment_configuration` PaymentConfiguration
      - `payment_providers` PaymentConfigurationItem[] — Provider-specific payment configuration.
        - `provider_type` 'stripe', required — The payment provider to configure.
        - `excluded_payment_method_types` string[] — List of Stripe payment method types to exclude for this customer. Excluded payment methods will not be available for the customer to select during payment, and will not be used for auto-collection. If a customer's default payment method becomes excluded, Orb will attempt to use the next available compatible payment method for auto-collection.
        - `default_shared_payment_token` string, nullable — The ID of a shared payment token granted by an agent to use as the default payment instrument for this customer. When set, auto-collection will use this token instead of the customer's default payment method.
    - `default_payment_method` PaymentMethod — A payment method represents a customer's stored payment instrument held with an external payment provider (such as Adyen or Stripe). The serialization is intentionally minimal for now; provider-pulled details (e.g. card display metadata) will be added over time.
      - `id` string, required — The Orb-assigned unique identifier for the payment method.
      - `payment_method_type` 'card' | 'us_bank_account' | 'link' | 'amazon_pay' | 'crypto', required — The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
      - `provider_type` string, nullable, required — The external payment provider this method belongs to, derived from the linked payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection has been removed.
      - `external_payment_method_id` string, required — The identifier of this payment method in the external payment provider.
      - `customer_id` string, required — The ID of the Orb customer this payment method is attached to.
      - `default` boolean, required — Whether this is the customer's default payment method.
      - `created_at` string, date-time, required — The time at which the payment method was created.
    - `hierarchy` CustomerHierarchy, required
      - `parent` CustomerMinified, required
        - `id` string, required
        - `external_customer_id` string, nullable, required
      - `children` CustomerMinified[], required
        - `id` string, required
        - `external_customer_id` string, nullable, required
    - `automatic_tax_enabled` boolean, nullable — Whether automatic tax calculation is enabled for this customer. This field is nullable for backwards compatibility but will always return a boolean value.
  - `plan` Plan, required — The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a customer. Plans define the billing behavior of the subscription. You can see more about how to configure prices in the [Price resource](/reference/price).
    - `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
    - `description` string, required
    - `maximum_amount` string, nullable, required
    - `minimum_amount` string, nullable, required
    - `created_at` string, date-time, required
    - `status` 'active' | 'archived' | 'draft', required
    - `maximum` Maximum, required
      - `maximum_amount` string, required — Maximum amount applied
      - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to.
        - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on.
        - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded.
        - `values` string[], required — The IDs or values that match this filter.
      - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
    - `minimum` Minimum, required
      - `minimum_amount` string, required — Minimum amount applied
      - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to.
        - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on.
        - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded.
        - `values` string[], required — The IDs or values that match this filter.
      - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
    - `discount` union, required
      - PercentageDiscount
        - `discount_type` 'percentage', required
        - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
        - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to.
          - `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.
        - `reason` string, nullable
        - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1.
      - TrialDiscount
        - `discount_type` 'trial', required
        - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
        - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to.
          - `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.
        - `reason` string, nullable
        - `trial_amount_discount` string, nullable — Only available if discount_type is `trial`
        - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial`
      - UsageDiscount
        - `discount_type` 'usage', required
        - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
        - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to.
          - `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.
        - `reason` string, nullable
        - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for
      - AmountDiscount
        - `discount_type` 'amount', required
        - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
        - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to.
          - `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.
        - `reason` string, nullable
        - `amount_discount` string, required — Only available if discount_type is `amount`.
      - TieredPercentageDiscount
        - `discount_type` 'tiered_percentage', required
        - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
        - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to.
          - `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.
        - `reason` string, nullable
        - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier).
          - `lower_bound` number, required — Exclusive lower bound of cumulative spend for this tier.
          - `upper_bound` number, nullable — Inclusive upper bound of cumulative spend for this tier; null for the final open-ended tier.
          - `percentage` number, required — The percentage (between 0 and 1) discounted from spend that falls within this tier.
    - `product` Product, required
      - `created_at` string, date-time, required
      - `id` string, required
      - `name` string, required
    - `version` integer, required
    - `trial_config` TrialConfig, required
      - `trial_period` integer, nullable, required
      - `trial_period_unit` 'days', required
    - `plan_phases` PlanPhase[], nullable, required
      - `id` string, required
      - `description` string, nullable, required
      - `duration` integer, nullable, required — How many terms of length `duration_unit` this phase is active for. If null, this phase is evergreen and active indefinitely
      - `duration_unit` 'daily' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual', nullable, required
      - `name` string, required
      - `order` integer, required — Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
      - `minimum` Minimum, required
        - `minimum_amount` string, required — Minimum amount applied
        - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to.
          - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on.
          - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded.
          - `values` string[], required — The IDs or values that match this filter.
        - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.
      - `maximum` Maximum, required
        - `maximum_amount` string, required — Maximum amount applied
        - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to.
          - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on.
          - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded.
          - `values` string[], required — The IDs or values that match this filter.
        - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.
      - `maximum_amount` string, nullable, required
      - `minimum_amount` string, nullable, required
      - `discount` union, required
        - PercentageDiscount
          - `discount_type` 'percentage', required
          - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
          - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to.
            - `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.
          - `reason` string, nullable
          - `percentage_discount` number, required — Only available if discount_type is `percentage`. This is a number between 0 and 1.
        - TrialDiscount
          - `discount_type` 'trial', required
          - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
          - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to.
            - `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.
          - `reason` string, nullable
          - `trial_amount_discount` string, nullable — Only available if discount_type is `trial`
          - `trial_percentage_discount` number, nullable — Only available if discount_type is `trial`
        - UsageDiscount
          - `discount_type` 'usage', required
          - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
          - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to.
            - `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.
          - `reason` string, nullable
          - `usage_discount` number, required — Only available if discount_type is `usage`. Number of usage units that this discount is for
        - AmountDiscount
          - `discount_type` 'amount', required
          - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
          - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to.
            - `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.
          - `reason` string, nullable
          - `amount_discount` string, required — Only available if discount_type is `amount`.
        - TieredPercentageDiscount
          - `discount_type` 'tiered_percentage', required
          - `applies_to_price_ids` string[], nullable — List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.
          - `filters` PriceFilter[], nullable — The filters that determine which prices to apply this discount to.
            - `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.
          - `reason` string, nullable
          - `tiers` PercentageTier[], required — Only available if discount_type is `tiered_percentage`. The ordered, contiguous bands of cumulative eligible spend, each discounted at its own percentage (progressive fill-a-tier).
            - `lower_bound` number, required — Exclusive lower bound of cumulative spend for this tier.
            - `upper_bound` number, nullable — Inclusive upper bound of cumulative spend for this tier; null for the final open-ended tier.
            - `percentage` number, required — The percentage (between 0 and 1) discounted from spend that falls within this tier.
    - `base_plan` PlanMinified, required
      - `id` string, nullable, required
      - `external_plan_id` string, nullable, required — An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.
      - `name` string, nullable, required
    - `base_plan_id` string, nullable, required — Legacy field representing the parent plan ID if the current plan is a 'child plan', overriding prices from the parent.
    - `external_plan_id` string, nullable, required — An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.
    - `currency` string, required — An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's prices.
    - `invoicing_currency` string, required — An ISO 4217 currency string for which this plan is billed in. Matches `currency` unless `currency` is a custom pricing unit.
    - `net_terms` integer, nullable, required — Determines the difference between the invoice issue date and the due date. A value of "0" here signifies that invoices are due on issue, whereas a value of "30" means that the customer has a month to pay the invoice before its overdue. Note that individual subscriptions or invoices may set a different net terms configuration.
    - `default_invoice_memo` string, nullable, required — The default memo text on the invoices corresponding to subscriptions on this plan. Note that each subscription may configure its own memo.
    - `prices` Price[], required — Prices for this plan. If the plan has phases, this includes prices across all phases of the plan.
      - union — The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill. Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present. For more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price)
        - UnitPrice
          - `model_type` 'unit', required — The pricing model type
          - `unit_config` UnitConfig, required — Configuration for unit pricing
            - `unit_amount` string, required — Rate per unit of usage
            - `prorated` boolean — If true, subtotals from this price are prorated based on the service period
          - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`.
          - `id` string, required
          - `name` string, required
          - `external_price_id` string, nullable, required
          - `replaces_price_id` string, nullable, required — The price id this price replaces. This price will take the place of the replaced price in plan version migrations.
          - `price_type` 'usage_price' | 'fixed_price' | 'composite_price', required
          - `created_at` string, date-time, required
          - `cadence` 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom', required
          - `billing_mode` 'in_advance' | 'in_arrear', required
          - `billing_cycle_configuration` BillingCycleConfiguration, required
            - `duration` integer, required
            - `duration_unit` 'day' | 'month', required
          - `invoicing_cycle_configuration` BillingCycleConfiguration, required
            - `duration` integer, required
            - `duration_unit` 'day' | 'month', required
          - `billable_metric` BillableMetricTiny, required
            - `id` string, required
          - `dimensional_price_configuration` DimensionalPriceConfiguration
            - `dimensional_price_group_id` string, required
            - `dimension_values` string[], required
          - `fixed_price_quantity` number, nullable, required
          - `plan_phase_order` integer, nullable, required
          - `currency` string, required
          - `conversion_rate` number, nullable, required
          - `conversion_rate_config` union, required
            - UnitConversionRateConfig
              - …
            - 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
- … 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)