> ## Documentation Index > Fetch the complete documentation index at: https://docs.withorb.com/llms.txt > Use this file to discover all available pages before exploring further. # Evaluate multiple prices > This endpoint is used to evaluate the output of price(s) for a given customer and time range over ingested events. It enables filtering and grouping the output using [computed properties](/extensibility/advanced-metrics#computed-properties), supporting the following workflows: 1. Showing detailed usage and costs to the end customer. 2. Auditing subtotals on invoice line items. For these workflows, the expressiveness of computed properties in both the filters and grouping is critical. For example, if you'd like to show your customer their usage grouped by hour and another property, you can do so with the following `grouping_keys`: `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd like to examine a customer's usage for a specific property value, you can do so with the following `filter`: `my_property = 'foo' AND my_other_property = 'bar'`. Prices may either reference existing prices in your Orb account or be defined inline in the request body. Up to 100 prices can be evaluated in a single request. Prices are evaluated on ingested events and the start of the time range must be no more than 100 days ago. To evaluate based off a set of provided events, the [evaluate preview events](/api-reference/price/evaluate-preview-events) endpoint can be used instead. Note that this is a POST endpoint rather than a GET endpoint because it employs a JSON body rather than query parameters. ## OpenAPI ````yaml /api-reference/orb-openapi.json post /prices/evaluate openapi: 3.1.0 info: title: API Reference description: >- Orb's API is built with the following principles in mind: 1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as cursor-based pagination and standardized error output. To help with debugging in critical API actions, the API always strives to provide detailed and actionable error messages. Aliases such as external customer IDs aid in fast integration times. 2. **Reliably real time**: Orb's event-based APIs, such as event ingestion are designed to handle extremely high throughput and scale with concurrent load. Orb also provides a real-time event-level credits ledger and a highly performant webhooks architecture. 3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage show the flexible nature of the platform. You can download the latest OpenAPI spec [here](https://api.withorb.com/spec.json) - pass `?version=3.0` for an OpenAPI 3.0-compatible spec. contact: name: Orb, Inc. url: https://www.withorb.com/ email: team@withorb.com version: '1.0' servers: - url: https://api.withorb.com/v1 description: Production server security: - APIKeyAuth: [] tags: - name: Alert description: >- [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending, usage, or credit balance and trigger webhooks when a threshold is exceeded. Alerts created through the API can be scoped to either customers or subscriptions. - name: Availability - name: Coupon description: >- A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription. Coupons are activated using a redemption code, which applies the discount to a subscription or invoice. The duration of a coupon determines how long it remains available for use by end users. - name: Credit description: >- The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb. - name: Credit note description: >- The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a particular invoice. - name: Customer description: >- 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. - name: Dimensional Price Group - name: Event description: >- The [Event](/core-concepts#event) resource represents a usage event that has been created for a customer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for a given billing period. - name: Invoice description: >- An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the request for payment for a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as the result of an action, such as a cancellation. - name: Item description: >- The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics, and prices and are used for defining external sync behavior for invoices and tax calculation purposes. - name: License - name: LicenseType description: >- 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. - name: Metric description: >- The Metric resource represents a calculation of a quantity based on events. Metrics are defined by the query that transforms raw usage events into meaningful values for your customers. - name: Plan description: >- 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). - name: Price description: >- 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) - name: Price interval description: >- The Price Interval resource represents a period of time for which a price will bill on a subscription. A subscription’s price intervals define its billing behavior. - name: Subscription description: >- A [subscription](/core-concepts#subscription) represents the purchase of a plan by a customer. By default, subscriptions begin on the day that they're created and renew automatically for each billing cycle at the cadence that's configured in the plan definition. Subscriptions also default to **beginning of month alignment**, which means the first invoice issued for the subscription will have pro-rated charges between the `start_date` and the first of the following month. Subsequent billing periods will always start and end on a month boundary (e.g. subsequent month starts for monthly billing). Depending on the plan configuration, any _flat_ recurring fees will be billed either at the beginning (in-advance) or end (in-arrears) of each billing cycle. Plans default to **in-advance billing**. Usage-based fees are billed in arrears as usage is accumulated. In the normal course of events, you can expect an invoice to contain usage-based charges for the previous period, and a recurring fee for the following period. - name: Subscription Change paths: /prices/evaluate: post: tags: - Price summary: Evaluate multiple prices description: >- This endpoint is used to evaluate the output of price(s) for a given customer and time range over ingested events. It enables filtering and grouping the output using [computed properties](/extensibility/advanced-metrics#computed-properties), supporting the following workflows: 1. Showing detailed usage and costs to the end customer. 2. Auditing subtotals on invoice line items. For these workflows, the expressiveness of computed properties in both the filters and grouping is critical. For example, if you'd like to show your customer their usage grouped by hour and another property, you can do so with the following `grouping_keys`: `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd like to examine a customer's usage for a specific property value, you can do so with the following `filter`: `my_property = 'foo' AND my_other_property = 'bar'`. Prices may either reference existing prices in your Orb account or be defined inline in the request body. Up to 100 prices can be evaluated in a single request. Prices are evaluated on ingested events and the start of the time range must be no more than 100 days ago. To evaluate based off a set of provided events, the [evaluate preview events](/api-reference/price/evaluate-preview-events) endpoint can be used instead. Note that this is a POST endpoint rather than a GET endpoint because it employs a JSON body rather than query parameters. operationId: evaluate-multiple-prices parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/EvaluateMultiplePricesBody' required: true responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/EvaluateMultiplePriceResource' '400': description: Bad Request headers: {} content: application/json: schema: $ref: '#/components/schemas/400Error' '401': description: Unauthorized headers: {} content: application/json: schema: $ref: '#/components/schemas/401Error' '404': description: Not Found headers: {} content: application/json: schema: $ref: '#/components/schemas/404Error' '409': description: Conflict headers: {} content: application/json: schema: $ref: '#/components/schemas/409Error' '413': description: Content Too Large headers: {} content: application/json: schema: $ref: '#/components/schemas/413Error' '429': description: Too Many Requests headers: {} content: application/json: schema: $ref: '#/components/schemas/429Error' '500': description: Internal Server Error headers: {} content: application/json: schema: $ref: '#/components/schemas/500Error' components: schemas: EvaluateMultiplePricesBody: properties: customer_id: oneOf: - type: string - type: 'null' title: Customer Id description: The ID of the customer to which this evaluation is scoped. external_customer_id: oneOf: - type: string - type: 'null' title: External Customer Id description: >- The external customer ID of the customer to which this evaluation is scoped. timeframe_start: type: string format: date-time title: Timeframe Start description: The inclusive lower bound for event timestamps timeframe_end: type: string format: date-time title: Timeframe End description: The exclusive upper bound for event timestamps price_evaluations: items: $ref: '#/components/schemas/PriceEvaluationRequest' type: array maxItems: 100 minItems: 1 title: Price Evaluations description: List of prices to evaluate (max 100) default: [] additionalProperties: false type: object required: - timeframe_start - timeframe_end title: EvaluateMultiplePricesBody EvaluateMultiplePriceResource: properties: data: items: $ref: '#/components/schemas/EvaluatePriceResourceForMultiplePrice' type: array title: Data type: object required: - data title: EvaluateMultiplePriceResource 400Error: oneOf: - $ref: '#/components/schemas/ConstraintViolationError' - $ref: '#/components/schemas/DuplicateResourceCreationError' - $ref: '#/components/schemas/RequestValidationError' 401Error: $ref: '#/components/schemas/AuthorizationError' title: 401Error 404Error: oneOf: - $ref: '#/components/schemas/FeatureNotAvailableError' - $ref: '#/components/schemas/ResourceNotFoundError' - $ref: '#/components/schemas/URLNotFound' 409Error: $ref: '#/components/schemas/IdempotencyRequestMismatch' title: 409Error 413Error: oneOf: - $ref: '#/components/schemas/RequestTooLargeError' - $ref: '#/components/schemas/ResourceTooLargeError' - $ref: '#/components/schemas/TooManyResultsError' 429Error: $ref: '#/components/schemas/TooManyRequests' title: 429Error 500Error: $ref: '#/components/schemas/ServerError' title: 500Error PriceEvaluationRequest: properties: price_id: oneOf: - type: string - type: 'null' title: Price Id description: The ID of a price to evaluate that exists in your Orb account. price: oneOf: - $ref: '#/components/schemas/NewFloatingPrice' - type: 'null' description: >- An inline price definition to evaluate, allowing you to test price configurations before adding them to Orb. external_price_id: oneOf: - type: string - type: 'null' title: External Price Id description: >- The external ID of a price to evaluate that exists in your Orb account. filter: oneOf: - type: string - type: 'null' title: Filter description: >- A boolean [computed property](/extensibility/advanced-metrics#computed-properties) used to filter the underlying billable metric examples: - my_numeric_property > 100 AND my_other_property = 'bar' - my_property = 'foo' grouping_keys: items: type: string type: array title: Grouping Keys description: >- Properties (or [computed properties](/extensibility/advanced-metrics#computed-properties)) used to group the underlying billable metric default: [] examples: - - case when my_event_type = 'foo' then true else false end - - hour_floor_timestamp_millis(timestamp_millis) - my_property metric_parameter_overrides: oneOf: - additionalProperties: true type: object - type: 'null' title: Metric Parameter Overrides description: >- Optional overrides for parameterized billable metric parameters. If the metric has parameter definitions and no overrides are provided, defaults will be used. type: object title: PriceEvaluationRequest EvaluatePriceResourceForMultiplePrice: properties: price_groups: items: $ref: '#/components/schemas/EvaluatePriceGroup' type: array title: Price Groups description: The computed price groups associated with input price. currency: type: string title: Currency description: The currency of the price price_id: oneOf: - type: string - type: 'null' title: Price Id description: The ID of the price external_price_id: oneOf: - type: string - type: 'null' title: External Price Id description: The external ID of the price inline_price_index: oneOf: - type: integer - type: 'null' title: Inline Price Index description: The index of the inline price type: object required: - price_groups - currency title: EvaluatePriceResourceForMultiplePrice ConstraintViolationError: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#400-constraint-violation title: Type status: type: integer enum: - 400 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: ConstraintViolationError DuplicateResourceCreationError: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation title: Type status: type: integer enum: - 400 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: DuplicateResourceCreationError RequestValidationError: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#400-request-validation-errors title: Type status: type: integer enum: - 400 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title validation_errors: items: {} type: array title: Validation Errors type: object required: - type - status - validation_errors title: RequestValidationError AuthorizationError: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#401-authentication-error title: Type status: type: integer enum: - 401 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: AuthorizationError FeatureNotAvailableError: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#404-feature-not-available title: Type status: type: integer enum: - 400 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: FeatureNotAvailableError ResourceNotFoundError: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#404-resource-not-found title: Type status: type: integer enum: - 404 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: type: string title: Title type: object required: - type - status - title title: ResourceNotFoundError URLNotFound: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#404-url-not-found title: Type status: type: integer enum: - 404 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: URLNotFound IdempotencyRequestMismatch: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#409-resource-conflict title: Type status: type: integer enum: - 409 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: IdempotencyRequestMismatch RequestTooLargeError: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#413-request-too-large title: Type status: type: integer enum: - 413 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: RequestTooLargeError ResourceTooLargeError: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#413-resource-too-large title: Type status: type: integer enum: - 413 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: ResourceTooLargeError TooManyResultsError: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#413-too-many-results title: Type status: type: integer enum: - 413 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: TooManyResultsError TooManyRequests: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#429-too-many-requests title: Type status: type: integer enum: - 429 title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: TooManyRequests ServerError: properties: type: type: string enum: - >- https://docs.withorb.com/reference/error-responses#500-internal-server-error title: Type status: type: integer title: Status detail: oneOf: - type: string - type: 'null' title: Detail title: oneOf: - type: string - type: 'null' title: Title type: object required: - type - status title: ServerError NewFloatingPrice: oneOf: - $ref: '#/components/schemas/NewFloatingUnitPrice' - $ref: '#/components/schemas/NewFloatingTieredPrice' - $ref: '#/components/schemas/NewFloatingBulkPrice' - $ref: '#/components/schemas/NewFloatingBulkWithFiltersPrice' - $ref: '#/components/schemas/NewFloatingPackagePrice' - $ref: '#/components/schemas/NewFloatingMatrixPrice' - $ref: '#/components/schemas/NewFloatingThresholdTotalAmountPrice' - $ref: '#/components/schemas/NewFloatingTieredPackagePrice' - $ref: '#/components/schemas/NewFloatingTieredWithMinimumPrice' - $ref: '#/components/schemas/NewFloatingGroupedTieredPrice' - $ref: '#/components/schemas/NewFloatingTieredPackageWithMinimumPrice' - $ref: '#/components/schemas/NewFloatingPackageWithAllocationPrice' - $ref: '#/components/schemas/NewFloatingUnitWithPercentPrice' - $ref: '#/components/schemas/NewFloatingMatrixWithAllocationPrice' - $ref: '#/components/schemas/NewFloatingMatrixWithThresholdDiscountsPrice' - $ref: '#/components/schemas/NewFloatingTieredWithProrationPrice' - $ref: '#/components/schemas/NewFloatingUnitWithProrationPrice' - $ref: '#/components/schemas/NewFloatingGroupedAllocationPrice' - $ref: '#/components/schemas/NewFloatingBulkWithProrationPrice' - $ref: '#/components/schemas/NewFloatingGroupedWithProratedMinimumPrice' - $ref: '#/components/schemas/NewFloatingGroupedWithMeteredMinimumPrice' - $ref: '#/components/schemas/NewFloatingGroupedWithMinMaxThresholdsPrice' - $ref: '#/components/schemas/NewFloatingMatrixWithDisplayNamePrice' - $ref: '#/components/schemas/NewFloatingGroupedTieredPackagePrice' - $ref: '#/components/schemas/NewFloatingMaxGroupTieredPackagePrice' - $ref: '#/components/schemas/NewFloatingScalableMatrixWithUnitPricingPrice' - $ref: '#/components/schemas/NewFloatingScalableMatrixWithTieredPricingPrice' - $ref: '#/components/schemas/NewFloatingCumulativeGroupedBulkPrice' - $ref: '#/components/schemas/NewFloatingCumulativeGroupedAllocationPrice' - $ref: '#/components/schemas/NewFloatingDailyCreditAllowancePrice' - $ref: '#/components/schemas/NewFloatingMeteredAllowancePrice' - $ref: '#/components/schemas/NewFloatingMinimumCompositePrice' - $ref: '#/components/schemas/NewFloatingPercentCompositePrice' - $ref: '#/components/schemas/NewFloatingEventOutputPrice' description: New floating price request body params. discriminator: propertyName: model_type mapping: bulk: $ref: '#/components/schemas/NewFloatingBulkPrice' bulk_with_filters: $ref: '#/components/schemas/NewFloatingBulkWithFiltersPrice' bulk_with_proration: $ref: '#/components/schemas/NewFloatingBulkWithProrationPrice' cumulative_grouped_allocation: $ref: '#/components/schemas/NewFloatingCumulativeGroupedAllocationPrice' cumulative_grouped_bulk: $ref: '#/components/schemas/NewFloatingCumulativeGroupedBulkPrice' daily_credit_allowance: $ref: '#/components/schemas/NewFloatingDailyCreditAllowancePrice' event_output: $ref: '#/components/schemas/NewFloatingEventOutputPrice' grouped_allocation: $ref: '#/components/schemas/NewFloatingGroupedAllocationPrice' grouped_tiered: $ref: '#/components/schemas/NewFloatingGroupedTieredPrice' grouped_tiered_package: $ref: '#/components/schemas/NewFloatingGroupedTieredPackagePrice' grouped_with_metered_minimum: $ref: '#/components/schemas/NewFloatingGroupedWithMeteredMinimumPrice' grouped_with_min_max_thresholds: $ref: '#/components/schemas/NewFloatingGroupedWithMinMaxThresholdsPrice' grouped_with_prorated_minimum: $ref: '#/components/schemas/NewFloatingGroupedWithProratedMinimumPrice' matrix: $ref: '#/components/schemas/NewFloatingMatrixPrice' matrix_with_allocation: $ref: '#/components/schemas/NewFloatingMatrixWithAllocationPrice' matrix_with_display_name: $ref: '#/components/schemas/NewFloatingMatrixWithDisplayNamePrice' matrix_with_threshold_discounts: $ref: '#/components/schemas/NewFloatingMatrixWithThresholdDiscountsPrice' max_group_tiered_package: $ref: '#/components/schemas/NewFloatingMaxGroupTieredPackagePrice' metered_allowance: $ref: '#/components/schemas/NewFloatingMeteredAllowancePrice' minimum_composite: $ref: '#/components/schemas/NewFloatingMinimumCompositePrice' package: $ref: '#/components/schemas/NewFloatingPackagePrice' package_with_allocation: $ref: '#/components/schemas/NewFloatingPackageWithAllocationPrice' percent: $ref: '#/components/schemas/NewFloatingPercentCompositePrice' scalable_matrix_with_tiered_pricing: $ref: >- #/components/schemas/NewFloatingScalableMatrixWithTieredPricingPrice scalable_matrix_with_unit_pricing: $ref: '#/components/schemas/NewFloatingScalableMatrixWithUnitPricingPrice' threshold_total_amount: $ref: '#/components/schemas/NewFloatingThresholdTotalAmountPrice' tiered: $ref: '#/components/schemas/NewFloatingTieredPrice' tiered_package: $ref: '#/components/schemas/NewFloatingTieredPackagePrice' tiered_package_with_minimum: $ref: '#/components/schemas/NewFloatingTieredPackageWithMinimumPrice' tiered_with_minimum: $ref: '#/components/schemas/NewFloatingTieredWithMinimumPrice' tiered_with_proration: $ref: '#/components/schemas/NewFloatingTieredWithProrationPrice' unit: $ref: '#/components/schemas/NewFloatingUnitPrice' unit_with_percent: $ref: '#/components/schemas/NewFloatingUnitWithPercentPrice' unit_with_proration: $ref: '#/components/schemas/NewFloatingUnitWithProrationPrice' EvaluatePriceGroup: properties: grouping_values: items: oneOf: - type: string - type: number - type: boolean type: array title: Grouping Values description: The values for the group in the order specified by `grouping_keys` quantity: type: number title: Quantity description: The price's usage quantity for the group amount: type: string title: Amount description: The price's output for the group type: object required: - grouping_values - quantity - amount title: EvaluatePriceGroup NewFloatingUnitPrice: properties: model_type: type: string enum: - unit title: Model Type description: The pricing model type unit_config: $ref: '#/components/schemas/UnitConfig' metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - unit_config - name - item_id - cadence - currency title: NewFloatingUnitPrice NewFloatingTieredPrice: properties: model_type: type: string enum: - tiered title: Model Type description: The pricing model type tiered_config: $ref: '#/components/schemas/TieredConfig' metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - tiered_config - name - item_id - cadence - currency title: NewFloatingTieredPrice NewFloatingBulkPrice: properties: model_type: type: string enum: - bulk title: Model Type description: The pricing model type bulk_config: $ref: '#/components/schemas/BulkConfig' metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - bulk_config - name - item_id - cadence - currency title: NewFloatingBulkPrice NewFloatingBulkWithFiltersPrice: properties: model_type: type: string enum: - bulk_with_filters title: Model Type description: The pricing model type bulk_with_filters_config: $ref: '#/components/schemas/BulkWithFiltersConfig' description: Configuration for bulk_with_filters pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - bulk_with_filters_config - name - item_id - cadence - currency title: NewFloatingBulkWithFiltersPrice NewFloatingPackagePrice: properties: model_type: type: string enum: - package title: Model Type description: The pricing model type package_config: $ref: '#/components/schemas/PackageConfig' metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - package_config - name - item_id - cadence - currency title: NewFloatingPackagePrice NewFloatingMatrixPrice: properties: model_type: type: string enum: - matrix title: Model Type description: The pricing model type matrix_config: $ref: '#/components/schemas/MatrixConfig' metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - matrix_config - name - item_id - cadence - currency title: NewFloatingMatrixPrice NewFloatingThresholdTotalAmountPrice: properties: model_type: type: string enum: - threshold_total_amount title: Model Type description: The pricing model type threshold_total_amount_config: $ref: '#/components/schemas/ThresholdTotalAmountConfig' description: Configuration for threshold_total_amount pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - threshold_total_amount_config - name - item_id - cadence - currency title: NewFloatingThresholdTotalAmountPrice NewFloatingTieredPackagePrice: properties: model_type: type: string enum: - tiered_package title: Model Type description: The pricing model type tiered_package_config: $ref: '#/components/schemas/TieredPackagePricingConfig' description: Configuration for tiered_package pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - tiered_package_config - name - item_id - cadence - currency title: NewFloatingTieredPackagePrice NewFloatingTieredWithMinimumPrice: properties: model_type: type: string enum: - tiered_with_minimum title: Model Type description: The pricing model type tiered_with_minimum_config: $ref: '#/components/schemas/TieredPricingWithMinimumConfig' description: Configuration for tiered_with_minimum pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - tiered_with_minimum_config - name - item_id - cadence - currency title: NewFloatingTieredWithMinimumPrice NewFloatingGroupedTieredPrice: properties: model_type: type: string enum: - grouped_tiered title: Model Type description: The pricing model type grouped_tiered_config: $ref: '#/components/schemas/GroupedTieredConfig' description: Configuration for grouped_tiered pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - grouped_tiered_config - name - item_id - cadence - currency title: NewFloatingGroupedTieredPrice NewFloatingTieredPackageWithMinimumPrice: properties: model_type: type: string enum: - tiered_package_with_minimum title: Model Type description: The pricing model type tiered_package_with_minimum_config: $ref: '#/components/schemas/TieredPackagePricingWithMinimumConfig' description: Configuration for tiered_package_with_minimum pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - tiered_package_with_minimum_config - name - item_id - cadence - currency title: NewFloatingTieredPackageWithMinimumPrice NewFloatingPackageWithAllocationPrice: properties: model_type: type: string enum: - package_with_allocation title: Model Type description: The pricing model type package_with_allocation_config: $ref: '#/components/schemas/PackageWithAllocationConfig' description: Configuration for package_with_allocation pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - package_with_allocation_config - name - item_id - cadence - currency title: NewFloatingPackageWithAllocationPrice NewFloatingUnitWithPercentPrice: properties: model_type: type: string enum: - unit_with_percent title: Model Type description: The pricing model type unit_with_percent_config: $ref: '#/components/schemas/UnitWithPercentConfig' description: Configuration for unit_with_percent pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - unit_with_percent_config - name - item_id - cadence - currency title: NewFloatingUnitWithPercentPrice NewFloatingMatrixWithAllocationPrice: properties: model_type: type: string enum: - matrix_with_allocation title: Model Type description: The pricing model type matrix_with_allocation_config: $ref: '#/components/schemas/MatrixWithAllocationConfig' description: Configuration for matrix_with_allocation pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - matrix_with_allocation_config - name - item_id - cadence - currency title: NewFloatingMatrixWithAllocationPrice NewFloatingMatrixWithThresholdDiscountsPrice: properties: model_type: type: string enum: - matrix_with_threshold_discounts title: Model Type description: The pricing model type matrix_with_threshold_discounts_config: $ref: '#/components/schemas/MatrixWithThresholdDiscountsConfig' description: Configuration for matrix_with_threshold_discounts pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - matrix_with_threshold_discounts_config - name - item_id - cadence - currency title: NewFloatingMatrixWithThresholdDiscountsPrice NewFloatingTieredWithProrationPrice: properties: model_type: type: string enum: - tiered_with_proration title: Model Type description: The pricing model type tiered_with_proration_config: $ref: '#/components/schemas/TieredWithProrationConfig' description: Configuration for tiered_with_proration pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - tiered_with_proration_config - name - item_id - cadence - currency title: NewFloatingTieredWithProrationPrice NewFloatingUnitWithProrationPrice: properties: model_type: type: string enum: - unit_with_proration title: Model Type description: The pricing model type unit_with_proration_config: $ref: '#/components/schemas/UnitWithProrationConfig' description: Configuration for unit_with_proration pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - unit_with_proration_config - name - item_id - cadence - currency title: NewFloatingUnitWithProrationPrice NewFloatingGroupedAllocationPrice: properties: model_type: type: string enum: - grouped_allocation title: Model Type description: The pricing model type grouped_allocation_config: $ref: '#/components/schemas/GroupedAllocationConfig' description: Configuration for grouped_allocation pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - grouped_allocation_config - name - item_id - cadence - currency title: NewFloatingGroupedAllocationPrice NewFloatingBulkWithProrationPrice: properties: model_type: type: string enum: - bulk_with_proration title: Model Type description: The pricing model type bulk_with_proration_config: $ref: '#/components/schemas/BulkWithProrationConfig' description: Configuration for bulk_with_proration pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - bulk_with_proration_config - name - item_id - cadence - currency title: NewFloatingBulkWithProrationPrice NewFloatingGroupedWithProratedMinimumPrice: properties: model_type: type: string enum: - grouped_with_prorated_minimum title: Model Type description: The pricing model type grouped_with_prorated_minimum_config: $ref: '#/components/schemas/GroupedWithProratedMinimumConfig' description: Configuration for grouped_with_prorated_minimum pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - grouped_with_prorated_minimum_config - name - item_id - cadence - currency title: NewFloatingGroupedWithProratedMinimumPrice NewFloatingGroupedWithMeteredMinimumPrice: properties: model_type: type: string enum: - grouped_with_metered_minimum title: Model Type description: The pricing model type grouped_with_metered_minimum_config: $ref: '#/components/schemas/GroupedWithMeteredMinimumConfig' description: Configuration for grouped_with_metered_minimum pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - grouped_with_metered_minimum_config - name - item_id - cadence - currency title: NewFloatingGroupedWithMeteredMinimumPrice NewFloatingGroupedWithMinMaxThresholdsPrice: properties: model_type: type: string enum: - grouped_with_min_max_thresholds title: Model Type description: The pricing model type grouped_with_min_max_thresholds_config: $ref: '#/components/schemas/GroupedWithMinMaxThresholdsConfig' description: Configuration for grouped_with_min_max_thresholds pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - grouped_with_min_max_thresholds_config - name - item_id - cadence - currency title: NewFloatingGroupedWithMinMaxThresholdsPrice NewFloatingMatrixWithDisplayNamePrice: properties: model_type: type: string enum: - matrix_with_display_name title: Model Type description: The pricing model type matrix_with_display_name_config: $ref: '#/components/schemas/MatrixWithDisplayNameConfig' description: Configuration for matrix_with_display_name pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - matrix_with_display_name_config - name - item_id - cadence - currency title: NewFloatingMatrixWithDisplayNamePrice NewFloatingGroupedTieredPackagePrice: properties: model_type: type: string enum: - grouped_tiered_package title: Model Type description: The pricing model type grouped_tiered_package_config: $ref: '#/components/schemas/GroupedTieredPackagePricingConfig' description: Configuration for grouped_tiered_package pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - grouped_tiered_package_config - name - item_id - cadence - currency title: NewFloatingGroupedTieredPackagePrice NewFloatingMaxGroupTieredPackagePrice: properties: model_type: type: string enum: - max_group_tiered_package title: Model Type description: The pricing model type max_group_tiered_package_config: $ref: '#/components/schemas/MaxGroupTieredPackageConfig' description: Configuration for max_group_tiered_package pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - max_group_tiered_package_config - name - item_id - cadence - currency title: NewFloatingMaxGroupTieredPackagePrice NewFloatingScalableMatrixWithUnitPricingPrice: properties: model_type: type: string enum: - scalable_matrix_with_unit_pricing title: Model Type description: The pricing model type scalable_matrix_with_unit_pricing_config: $ref: '#/components/schemas/ScalableMatrixWithUnitPricingConfig' description: Configuration for scalable_matrix_with_unit_pricing pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - scalable_matrix_with_unit_pricing_config - name - item_id - cadence - currency title: NewFloatingScalableMatrixWithUnitPricingPrice NewFloatingScalableMatrixWithTieredPricingPrice: properties: model_type: type: string enum: - scalable_matrix_with_tiered_pricing title: Model Type description: The pricing model type scalable_matrix_with_tiered_pricing_config: $ref: '#/components/schemas/ScalableMatrixWithTieredPricingConfig' description: Configuration for scalable_matrix_with_tiered_pricing pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - scalable_matrix_with_tiered_pricing_config - name - item_id - cadence - currency title: NewFloatingScalableMatrixWithTieredPricingPrice NewFloatingCumulativeGroupedBulkPrice: properties: model_type: type: string enum: - cumulative_grouped_bulk title: Model Type description: The pricing model type cumulative_grouped_bulk_config: $ref: '#/components/schemas/CumulativeGroupedBulkConfig' description: Configuration for cumulative_grouped_bulk pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - cumulative_grouped_bulk_config - name - item_id - cadence - currency title: NewFloatingCumulativeGroupedBulkPrice NewFloatingCumulativeGroupedAllocationPrice: properties: model_type: type: string enum: - cumulative_grouped_allocation title: Model Type description: The pricing model type cumulative_grouped_allocation_config: $ref: '#/components/schemas/CumulativeGroupedAllocationConfig' description: Configuration for cumulative_grouped_allocation pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - cumulative_grouped_allocation_config - name - item_id - cadence - currency title: NewFloatingCumulativeGroupedAllocationPrice NewFloatingDailyCreditAllowancePrice: properties: model_type: type: string enum: - daily_credit_allowance title: Model Type description: The pricing model type daily_credit_allowance_config: $ref: '#/components/schemas/DailyCreditAllowanceConfig' description: Configuration for daily_credit_allowance pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - daily_credit_allowance_config - name - item_id - cadence - currency title: NewFloatingDailyCreditAllowancePrice NewFloatingMeteredAllowancePrice: properties: model_type: type: string enum: - metered_allowance title: Model Type description: The pricing model type metered_allowance_config: $ref: '#/components/schemas/MeteredAllowanceConfig' description: Configuration for metered_allowance pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - metered_allowance_config - name - item_id - cadence - currency title: NewFloatingMeteredAllowancePrice NewFloatingMinimumCompositePrice: properties: model_type: type: string enum: - minimum_composite title: Model Type description: The pricing model type minimum_composite_config: $ref: '#/components/schemas/MinimumCompositeConfig' description: Configuration for minimum_composite pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - minimum_composite_config - name - item_id - cadence - currency title: NewFloatingMinimumCompositePrice NewFloatingPercentCompositePrice: properties: model_type: type: string enum: - percent title: Model Type description: The pricing model type percent_config: $ref: '#/components/schemas/PercentCompositeConfig' description: Configuration for percent pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - percent_config - name - item_id - cadence - currency title: NewFloatingPercentCompositePrice NewFloatingEventOutputPrice: properties: model_type: type: string enum: - event_output title: Model Type description: The pricing model type event_output_config: $ref: '#/components/schemas/EventOutputConfig' description: Configuration for event_output pricing metadata: oneOf: - additionalProperties: oneOf: - type: string - type: 'null' type: object - type: 'null' title: Metadata description: >- 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: oneOf: - type: string - type: 'null' title: External Price Id description: An alias for the price. name: type: string title: Name description: The name of the price. examples: - Annual fee dimensional_price_configuration: oneOf: - $ref: '#/components/schemas/NewDimensionalPriceConfiguration' - type: 'null' description: 'For dimensional price: specifies a price group and dimension values' license_type_id: oneOf: - type: string - type: 'null' title: License Type Id description: The ID of the license type to associate with this price. billable_metric_id: oneOf: - type: string - type: 'null' title: Billable Metric Id description: >- The id of the billable metric for the price. Only needed if the price is usage-based. item_id: type: string title: Item Id description: The id of the item the price will be associated with. billed_in_advance: oneOf: - type: boolean - type: 'null' title: Billed In Advance description: >- 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: oneOf: - type: number - type: 'null' title: Fixed Price Quantity description: >- If the Price represents a fixed cost, this represents the quantity of units applied. invoice_grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Invoice Grouping Key description: The property used to group this price on an invoice cadence: type: string enum: - annual - semi_annual - monthly - quarterly - one_time - custom title: Cadence description: The cadence to bill for this price on. billing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- For custom cadence: specifies the duration of the billing period in days or months. invoicing_cycle_configuration: oneOf: - $ref: '#/components/schemas/NewBillingCycleConfiguration' - type: 'null' description: >- Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle. conversion_rate: oneOf: - type: number - type: 'null' title: Conversion Rate description: >- The per unit conversion rate of the price currency to the invoicing currency. conversion_rate_config: oneOf: - $ref: '#/components/schemas/ConversionRateConfig' - type: 'null' description: >- The configuration for the rate of the price currency to the invoicing currency. currency: type: string title: Currency description: An ISO 4217 currency string for which this price is billed in. additionalProperties: false type: object required: - model_type - event_output_config - name - item_id - cadence - currency title: NewFloatingEventOutputPrice UnitConfig: properties: unit_amount: type: string title: Unit Amount description: Rate per unit of usage prorated: type: boolean title: Prorated description: >- If true, subtotals from this price are prorated based on the service period default: false additionalProperties: false type: object required: - unit_amount title: UnitConfig description: Configuration for unit pricing NewDimensionalPriceConfiguration: properties: dimensional_price_group_id: oneOf: - type: string - type: 'null' title: Dimensional Price Group Id description: The id of the dimensional price group to include this price in external_dimensional_price_group_id: oneOf: - type: string - type: 'null' title: External Dimensional Price Group Id description: >- The external id of the dimensional price group to include this price in dimension_values: items: type: string type: array title: Dimension Values description: >- The list of dimension values matching (in order) the dimensions of the price group additionalProperties: false type: object required: - dimension_values title: NewDimensionalPriceConfiguration NewBillingCycleConfiguration: properties: duration: type: integer title: Duration description: The duration of the billing period. duration_unit: type: string enum: - day - month title: Duration Unit description: The unit of billing period duration. additionalProperties: false type: object required: - duration - duration_unit title: NewBillingCycleConfiguration ConversionRateConfig: oneOf: - $ref: '#/components/schemas/UnitConversionRateConfig' - $ref: '#/components/schemas/TieredConversionRateConfig' discriminator: propertyName: conversion_rate_type mapping: tiered: $ref: '#/components/schemas/TieredConversionRateConfig' unit: $ref: '#/components/schemas/UnitConversionRateConfig' TieredConfig: properties: tiers: items: $ref: '#/components/schemas/Tier' type: array minItems: 1 title: Tiers description: >- Tiers for rating based on total usage quantities into the specified tier prorated: type: boolean title: Prorated description: >- If true, subtotals from this price are prorated based on the service period default: false additionalProperties: false type: object required: - tiers title: TieredConfig description: Configuration for tiered pricing BulkConfig: properties: tiers: items: $ref: '#/components/schemas/BulkTier' type: array minItems: 1 title: Tiers description: Bulk tiers for rating based on total usage volume additionalProperties: false type: object required: - tiers title: BulkConfig description: Configuration for bulk pricing BulkWithFiltersConfig: properties: tiers: items: $ref: '#/components/schemas/BulkWithFiltersTier' type: array minItems: 2 title: Tiers description: Bulk tiers for rating based on total usage volume filters: items: $ref: '#/components/schemas/FilterRule' type: array minItems: 1 title: Filters description: Property filters to apply (all must match) additionalProperties: false type: object required: - tiers - filters title: BulkWithFiltersConfig description: >- 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. PackageConfig: properties: package_amount: type: string title: Package Amount description: A currency amount to rate usage by package_size: type: integer minimum: 1 title: Package Size description: >- An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating additionalProperties: false type: object required: - package_amount - package_size title: PackageConfig description: Configuration for package pricing MatrixConfig: properties: dimensions: items: oneOf: - type: string - type: 'null' type: array title: Dimensions description: One or two event property values to evaluate matrix groups by default_unit_amount: type: string title: Default Unit Amount description: >- Default per unit rate for any usage not bucketed into a specified matrix_value matrix_values: items: $ref: '#/components/schemas/MatrixValue' type: array minItems: 1 title: Matrix Values description: Matrix values configuration additionalProperties: false type: object required: - dimensions - default_unit_amount - matrix_values title: MatrixConfig description: Configuration for matrix pricing ThresholdTotalAmountConfig: properties: consumption_table: items: $ref: '#/components/schemas/TieredTotalThreshold' type: array minItems: 2 title: Consumption Table description: >- When the quantity consumed passes a provided threshold, the configured total will be charged prorate: oneOf: - type: boolean - type: 'null' title: Prorate description: If true, the unit price will be prorated to the billing period default: false additionalProperties: false type: object required: - consumption_table title: ThresholdTotalAmountConfig description: Configuration for tiered total pricing TieredPackagePricingConfig: properties: tiers: items: $ref: '#/components/schemas/TieredPackageTierItem' type: array minItems: 2 title: Tiers description: >- 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: type: string title: Package Size additionalProperties: false type: object required: - tiers - package_size title: TieredPackagePricingConfig description: Configuration for tiered package pricing TieredPricingWithMinimumConfig: properties: tiers: items: $ref: '#/components/schemas/TieredPricingWithMinimumTierItem' type: array minItems: 2 title: Tiers description: >- Tiered pricing with a minimum amount dependent on the volume tier. Tiers are defined using exclusive lower bounds. hide_zero_amount_tiers: type: boolean title: Hide Zero Amount Tiers description: >- If true, tiers with an accrued amount of 0 will not be included in the rating. prorate: type: boolean title: Prorate description: If true, the unit price will be prorated to the billing period additionalProperties: false type: object required: - tiers title: TieredPricingWithMinimumConfig description: Configuration for tiered pricing with minimum GroupedTieredConfig: properties: tiers: items: $ref: '#/components/schemas/GroupedTieredTier' type: array minItems: 2 title: Tiers description: >- Apply tiered pricing to each segment generated after grouping with the provided key grouping_key: type: string minLength: 1 title: Grouping Key description: The billable metric property used to group before tiering additionalProperties: false type: object required: - tiers - grouping_key title: GroupedTieredConfig description: Configuration for grouped tiered pricing TieredPackagePricingWithMinimumConfig: properties: tiers: items: $ref: '#/components/schemas/TieredPackageWithMinimumTierItem' type: array minItems: 2 title: Tiers description: >- Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. package_size: type: number title: Package Size additionalProperties: false type: object required: - tiers - package_size title: TieredPackagePricingWithMinimumConfig description: Configuration for tiered package pricing with minimum PackageWithAllocationConfig: properties: package_amount: type: string title: Package Amount package_size: type: string title: Package Size allocation: type: string title: Allocation additionalProperties: false type: object required: - package_amount - package_size - allocation title: PackageWithAllocationConfig description: Configuration for package pricing with usage allocation UnitWithPercentConfig: properties: unit_amount: type: string title: Unit Amount description: Rate per unit of usage percent: type: string title: Percent description: What percent, out of 100, of the calculated total to charge additionalProperties: false type: object required: - unit_amount - percent title: UnitWithPercentConfig description: Configuration for unit pricing with percentage MatrixWithAllocationConfig: properties: dimensions: items: oneOf: - type: string - type: 'null' type: array title: Dimensions description: One or two event property values to evaluate matrix groups by default_unit_amount: type: string title: Default Unit Amount description: >- Default per unit rate for any usage not bucketed into a specified matrix_value allocation: type: string title: Allocation description: Usage allocation matrix_values: items: $ref: '#/components/schemas/MatrixWithAllocationValueItem' type: array minItems: 1 title: Matrix Values description: Matrix values configuration additionalProperties: false type: object required: - dimensions - default_unit_amount - allocation - matrix_values title: MatrixWithAllocationConfig description: Configuration for matrix pricing with usage allocation MatrixWithThresholdDiscountsConfig: properties: first_dimension: type: string title: First Dimension description: First matrix dimension key. second_dimension: oneOf: - type: string - type: 'null' title: Second Dimension description: Optional second matrix dimension key. default_unit_amount: type: string title: Default Unit Amount description: >- Unit price used for usage that does not match any defined matrix cell. matrix_values: items: $ref: '#/components/schemas/MatrixCell' type: array minItems: 1 title: Matrix Values description: Per-cell unit prices. threshold_discount_groups: items: $ref: '#/components/schemas/ThresholdDiscountGroup' type: array title: Threshold Discount Groups additionalProperties: false type: object required: - first_dimension - default_unit_amount - matrix_values title: MatrixWithThresholdDiscountsConfig description: >- 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. TieredWithProrationConfig: properties: tiers: items: $ref: '#/components/schemas/TieredWithProrationTier' type: array minItems: 1 title: Tiers description: >- Tiers for rating based on total usage quantities into the specified tier with proration additionalProperties: false type: object required: - tiers title: TieredWithProrationConfig description: Configuration for tiered pricing with proration UnitWithProrationConfig: properties: unit_amount: type: string title: Unit Amount description: Rate per unit of usage additionalProperties: false type: object required: - unit_amount title: UnitWithProrationConfig description: Configuration for unit pricing with proration GroupedAllocationConfig: properties: grouping_key: type: string minLength: 1 title: Grouping Key description: >- How to determine the groups that should each be allocated some quantity overage_unit_rate: type: string title: Overage Unit Rate description: Unit rate for post-allocation allocation: type: string title: Allocation description: Usage allocation per group additionalProperties: false type: object required: - grouping_key - overage_unit_rate - allocation title: GroupedAllocationConfig description: Configuration for grouped allocation pricing BulkWithProrationConfig: properties: tiers: items: $ref: '#/components/schemas/BulkTierWithProration' type: array minItems: 2 title: Tiers description: Bulk tiers for rating based on total usage volume additionalProperties: false type: object required: - tiers title: BulkWithProrationConfig description: Configuration for bulk pricing with proration GroupedWithProratedMinimumConfig: properties: grouping_key: type: string minLength: 1 title: Grouping Key description: How to determine the groups that should each have a minimum unit_rate: type: string title: Unit Rate description: The amount to charge per unit minimum: type: string title: Minimum description: The minimum amount to charge per group additionalProperties: false type: object required: - grouping_key - unit_rate - minimum title: GroupedWithProratedMinimumConfig description: Configuration for grouped with prorated minimum pricing GroupedWithMeteredMinimumConfig: properties: grouping_key: type: string minLength: 1 title: Grouping Key description: >- Used to partition the usage into groups. The minimum amount is applied to each group. pricing_key: type: string title: Pricing Key description: Used to determine the unit rate scaling_key: type: string title: Scaling Key description: Used to determine the unit rate scaling factor scaling_factors: items: $ref: '#/components/schemas/GroupedWithMeteredMinimumScalingFactorItem' type: array minItems: 1 title: Scaling Factors description: Scale the unit rates by the scaling factor. unit_amounts: items: $ref: '#/components/schemas/GroupedWithMeteredMinimumUnitAmountItem' type: array minItems: 1 title: Unit Amounts description: >- Apply per unit pricing to each pricing value. The minimum amount is applied any unmatched usage. minimum_unit_amount: type: string title: Minimum Unit Amount description: The minimum amount to charge per group per unit additionalProperties: false type: object required: - grouping_key - pricing_key - scaling_key - scaling_factors - unit_amounts - minimum_unit_amount title: GroupedWithMeteredMinimumConfig description: Configuration for grouped with metered minimum pricing GroupedWithMinMaxThresholdsConfig: properties: grouping_key: type: string minLength: 1 title: Grouping Key description: The event property used to group before applying thresholds per_unit_rate: type: string title: Per Unit Rate description: The base price charged per group minimum_charge: type: string title: Minimum Charge description: The minimum amount to charge each group, regardless of usage maximum_charge: type: string title: Maximum Charge description: The maximum amount to charge each group additionalProperties: false type: object required: - grouping_key - per_unit_rate - minimum_charge - maximum_charge title: GroupedWithMinMaxThresholdsConfig description: Configuration for grouped with minimum and maximum thresholds pricing MatrixWithDisplayNameConfig: properties: dimension: type: string title: Dimension description: Used to determine the unit rate unit_amounts: items: $ref: '#/components/schemas/MatrixWithDisplayNameUnitAmountItem' type: array minItems: 1 title: Unit Amounts description: Apply per unit pricing to each dimension value additionalProperties: false type: object required: - dimension - unit_amounts title: MatrixWithDisplayNameConfig description: Configuration for matrix with display name pricing GroupedTieredPackagePricingConfig: properties: tiers: items: $ref: '#/components/schemas/GroupedTieredPackageTierItem' type: array minItems: 2 title: Tiers description: >- Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. package_size: type: string title: Package Size grouping_key: type: string minLength: 1 title: Grouping Key description: The event property used to group before tiering additionalProperties: false type: object required: - tiers - package_size - grouping_key title: GroupedTieredPackagePricingConfig description: Configuration for grouped tiered package pricing MaxGroupTieredPackageConfig: properties: tiers: items: $ref: '#/components/schemas/MaxGroupTieredTierItem' type: array minItems: 2 title: Tiers description: >- Apply tiered pricing to the largest group after grouping with the provided key. package_size: type: string title: Package Size grouping_key: type: string minLength: 1 title: Grouping Key description: >- The event property used to group before tiering the group with the highest value additionalProperties: false type: object required: - tiers - package_size - grouping_key title: MaxGroupTieredPackageConfig description: Configuration for max group tiered package pricing ScalableMatrixWithUnitPricingConfig: properties: grouping_key: oneOf: - type: string minLength: 1 - type: 'null' title: Grouping Key description: The property used to group this price unit_price: type: string title: Unit Price description: The final unit price to rate against the output of the matrix first_dimension: type: string title: First Dimension description: Used to determine the unit rate second_dimension: oneOf: - type: string - type: 'null' title: Second Dimension description: Used to determine the unit rate (optional) matrix_scaling_factors: items: $ref: '#/components/schemas/ScalableMatrixWithUnitScalingFactor' type: array minItems: 1 title: Matrix Scaling Factors description: Apply a scaling factor to each dimension prorate: oneOf: - type: boolean - type: 'null' title: Prorate description: If true, the unit price will be prorated to the billing period default: false additionalProperties: false type: object required: - unit_price - first_dimension - matrix_scaling_factors title: ScalableMatrixWithUnitPricingConfig description: Configuration for scalable matrix with unit pricing ScalableMatrixWithTieredPricingConfig: properties: tiers: items: $ref: '#/components/schemas/ScalableMatrixWithTieredTierEntry' type: array minItems: 2 title: Tiers first_dimension: type: string title: First Dimension description: Used for the scalable matrix first dimension second_dimension: oneOf: - type: string - type: 'null' title: Second Dimension description: Used for the scalable matrix second dimension (optional) matrix_scaling_factors: items: $ref: '#/components/schemas/ScalableMatrixWithTieredScalingFactor' type: array minItems: 1 title: Matrix Scaling Factors description: Apply a scaling factor to each dimension additionalProperties: false type: object required: - tiers - first_dimension - matrix_scaling_factors title: ScalableMatrixWithTieredPricingConfig description: Configuration for scalable matrix with tiered pricing CumulativeGroupedBulkConfig: properties: group: type: string title: Group dimension_values: items: $ref: '#/components/schemas/CumulativeGroupedBulkDimensionValue' type: array minItems: 1 title: Dimension Values description: Each tier lower bound must have the same group of values. additionalProperties: false type: object required: - group - dimension_values title: CumulativeGroupedBulkConfig description: Configuration for cumulative grouped bulk pricing CumulativeGroupedAllocationConfig: properties: grouping_key: type: string minLength: 1 title: Grouping Key description: The event property used to group usage before applying allocations group_allocation: type: string title: Group Allocation description: The allocation per individual group cumulative_allocation: type: string title: Cumulative Allocation description: The overall allocation across all groups unit_amount: type: string title: Unit Amount description: The amount to charge for each unit outside of the allocation additionalProperties: false type: object required: - grouping_key - group_allocation - cumulative_allocation - unit_amount title: CumulativeGroupedAllocationConfig description: >- 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. DailyCreditAllowanceConfig: properties: event_day_property: type: string minLength: 1 title: Event Day Property description: >- 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: items: oneOf: - type: string - type: 'null' type: array maxItems: 2 minItems: 1 title: Dimensions description: One or two event property values to evaluate matrix groups by default_unit_amount: type: string title: Default Unit Amount description: >- Default per-unit credit rate for any usage not bucketed into a specified matrix_value daily_allowance: type: string title: Daily Allowance description: Credits granted per day. Lose-it-or-use-it; does not roll over. matrix_values: items: $ref: '#/components/schemas/DailyCreditAllowanceMatrixValue' type: array minItems: 1 title: Matrix Values description: Per-dimension credit rates additionalProperties: false type: object required: - event_day_property - dimensions - default_unit_amount - daily_allowance - matrix_values title: DailyCreditAllowanceConfig description: >- 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. MeteredAllowanceConfig: properties: grouping_key: type: string minLength: 1 title: Grouping Key description: >- 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: type: string minLength: 1 title: Consumption Grouping Value description: >- The grouping_key value whose summed quantity represents consumption (e.g. 'download'). Charged at unit_amount. allowance_grouping_value: type: string minLength: 1 title: Allowance Grouping Value description: >- 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: type: string title: Unit Amount description: >- Per-unit price applied to gross consumption and to the allowance credit. consumption_display_name: type: string minLength: 1 title: Consumption Display Name description: Sub-line label for the gross consumption row (e.g. 'bytes gotten'). default: Consumption allowance_display_name: type: string minLength: 1 title: Allowance Display Name description: Sub-line label for the credit row (e.g. 'Up to 3x free egress'). default: Allowance credit additionalProperties: false type: object required: - grouping_key - consumption_grouping_value - allowance_grouping_value - unit_amount title: MeteredAllowanceConfig description: >- 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. MinimumCompositeConfig: properties: minimum_amount: type: string title: Minimum Amount description: The minimum amount to apply prorated: type: boolean title: Prorated description: >- If true, subtotals from this price are prorated based on the service period additionalProperties: false type: object required: - minimum_amount title: MinimumCompositeConfig description: Configuration for minimum composite price PercentCompositeConfig: properties: percent: type: number maximum: 1 exclusiveMinimum: 0 title: Percent description: Fraction of the component subtotals to charge (0 < percent <= 1). minimum_amount: oneOf: - type: string - type: 'null' title: Minimum Amount description: Minimum amount to charge. If unset, the fee is bounded below by 0. maximum_amount: oneOf: - type: string - type: 'null' title: Maximum Amount description: Maximum amount to charge. If unset, the fee has no upper bound. prorated: type: boolean title: Prorated description: >- 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. additionalProperties: false type: object required: - percent title: PercentCompositeConfig description: >- 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) EventOutputConfig: properties: unit_rating_key: type: string minLength: 1 title: Unit Rating Key description: The key in the event data to extract the unit rate from. grouping_key: oneOf: - type: string - type: 'null' title: Grouping Key description: >- 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: oneOf: - type: string - type: 'null' title: Default Unit Rate description: >- 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. additionalProperties: false type: object required: - unit_rating_key title: EventOutputConfig UnitConversionRateConfig: properties: conversion_rate_type: type: string enum: - unit title: Conversion Rate Type unit_config: $ref: '#/components/schemas/ConversionRateUnitConfig' additionalProperties: false type: object required: - conversion_rate_type - unit_config title: UnitConversionRateConfig TieredConversionRateConfig: properties: conversion_rate_type: type: string enum: - tiered title: Conversion Rate Type tiered_config: $ref: '#/components/schemas/ConversionRateTieredConfig' additionalProperties: false type: object required: - conversion_rate_type - tiered_config title: TieredConversionRateConfig Tier: properties: first_unit: type: number title: First Unit description: Exclusive tier starting value last_unit: oneOf: - type: number - type: 'null' title: Last Unit description: >- Inclusive tier ending value. This value is null if and only if this is the last tier. unit_amount: type: string title: Unit Amount description: Amount per unit additionalProperties: false type: object required: - first_unit - unit_amount title: Tier description: Configuration for a single tier BulkTier: properties: maximum_units: oneOf: - type: number - type: 'null' title: Maximum Units description: Upper bound for this tier unit_amount: type: string title: Unit Amount description: Amount per unit additionalProperties: false type: object required: - unit_amount title: BulkTier description: Configuration for a single bulk pricing tier BulkWithFiltersTier: properties: tier_lower_bound: oneOf: - type: string - type: 'null' title: Tier Lower Bound description: The lower bound for this tier unit_amount: type: string title: Unit Amount description: Amount per unit additionalProperties: false type: object required: - unit_amount title: BulkWithFiltersTier description: Configuration for a single bulk pricing tier FilterRule: properties: property_key: type: string minLength: 1 title: Property Key description: Event property key to filter on property_value: type: string minLength: 1 title: Property Value description: Event property value to match additionalProperties: false type: object required: - property_key - property_value title: FilterRule description: Configuration for a single property filter MatrixValue: properties: unit_amount: type: string title: Unit Amount description: Unit price for the specified dimension_values dimension_values: items: oneOf: - type: string - type: 'null' type: array title: Dimension Values description: One or two matrix keys to filter usage to this Matrix value by additionalProperties: false type: object required: - unit_amount - dimension_values title: MatrixValue description: Configuration for a single matrix value TieredTotalThreshold: properties: threshold: type: string title: Threshold total_amount: type: string title: Total Amount description: Total amount for this threshold additionalProperties: false type: object required: - threshold - total_amount title: TieredTotalThreshold description: Configuration for a single threshold TieredPackageTierItem: properties: tier_lower_bound: type: string title: Tier Lower Bound per_unit: type: string title: Per Unit description: Price per package additionalProperties: false type: object required: - tier_lower_bound - per_unit title: TieredPackageTierItem description: Configuration for a single tier with business logic TieredPricingWithMinimumTierItem: properties: tier_lower_bound: type: string title: Tier Lower Bound unit_amount: type: string title: Unit Amount description: Per unit amount minimum_amount: type: string title: Minimum Amount additionalProperties: false type: object required: - tier_lower_bound - unit_amount - minimum_amount title: TieredPricingWithMinimumTierItem description: Configuration for a single tier GroupedTieredTier: properties: tier_lower_bound: type: string title: Tier Lower Bound unit_amount: type: string title: Unit Amount description: Per unit amount additionalProperties: false type: object required: - tier_lower_bound - unit_amount title: GroupedTieredTier description: Configuration for a single tier TieredPackageWithMinimumTierItem: properties: tier_lower_bound: type: string title: Tier Lower Bound per_unit: type: string title: Per Unit minimum_amount: type: string title: Minimum Amount additionalProperties: false type: object required: - tier_lower_bound - per_unit - minimum_amount title: TieredPackageWithMinimumTierItem description: Configuration for a single tier MatrixWithAllocationValueItem: properties: unit_amount: type: string title: Unit Amount description: Unit price for the specified dimension_values dimension_values: items: oneOf: - type: string - type: 'null' type: array title: Dimension Values description: >- 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. additionalProperties: false type: object required: - unit_amount - dimension_values title: MatrixWithAllocationValueItem description: Configuration for a single matrix value MatrixCell: properties: first_dimension_value: type: string title: First Dimension Value second_dimension_value: oneOf: - type: string - type: 'null' title: Second Dimension Value unit_amount: type: string title: Unit Amount additionalProperties: false type: object required: - first_dimension_value - unit_amount title: MatrixCell ThresholdDiscountGroup: properties: description: oneOf: - type: string - type: 'null' title: Description cell_coordinates: type: string title: Cell Coordinates description: >- 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: type: string title: Threshold Amount below_threshold_discount_percentage: type: string title: Below Threshold Discount Percentage description: >- Discount rate applied to spend at or below the threshold. Set to 0 for no baseline discount. above_threshold_discount_percentage: type: string title: Above Threshold Discount Percentage description: Discount rate applied to spend above the threshold. additionalProperties: false type: object required: - cell_coordinates - threshold_amount - below_threshold_discount_percentage - above_threshold_discount_percentage title: ThresholdDiscountGroup TieredWithProrationTier: properties: tier_lower_bound: type: string title: Tier Lower Bound description: Inclusive tier starting value unit_amount: type: string title: Unit Amount description: Amount per unit additionalProperties: false type: object required: - tier_lower_bound - unit_amount title: TieredWithProrationTier description: Configuration for a single tiered with proration tier BulkTierWithProration: properties: tier_lower_bound: oneOf: - type: string - type: 'null' title: Tier Lower Bound description: The lower bound for this tier unit_amount: type: string title: Unit Amount description: Cost per unit additionalProperties: false type: object required: - unit_amount title: BulkTierWithProration description: Configuration for a single bulk pricing tier with proration GroupedWithMeteredMinimumScalingFactorItem: properties: scaling_value: type: string title: Scaling Value scaling_factor: type: string title: Scaling Factor additionalProperties: false type: object required: - scaling_value - scaling_factor title: GroupedWithMeteredMinimumScalingFactorItem description: Configuration for a scaling factor GroupedWithMeteredMinimumUnitAmountItem: properties: pricing_value: type: string title: Pricing Value unit_amount: type: string title: Unit Amount description: Per unit amount additionalProperties: false type: object required: - pricing_value - unit_amount title: GroupedWithMeteredMinimumUnitAmountItem description: Configuration for a unit amount MatrixWithDisplayNameUnitAmountItem: properties: display_name: type: string title: Display Name description: Display name for this dimension value dimension_value: type: string title: Dimension Value description: The dimension value unit_amount: type: string title: Unit Amount description: Per unit amount additionalProperties: false type: object required: - display_name - dimension_value - unit_amount title: MatrixWithDisplayNameUnitAmountItem description: Configuration for a unit amount item GroupedTieredPackageTierItem: properties: tier_lower_bound: type: string title: Tier Lower Bound per_unit: type: string title: Per Unit description: Per package additionalProperties: false type: object required: - tier_lower_bound - per_unit title: GroupedTieredPackageTierItem description: Configuration for a single tier MaxGroupTieredTierItem: properties: tier_lower_bound: type: string title: Tier Lower Bound unit_amount: type: string title: Unit Amount description: Per unit amount additionalProperties: false type: object required: - tier_lower_bound - unit_amount title: MaxGroupTieredTierItem description: Configuration for a single tier ScalableMatrixWithUnitScalingFactor: properties: first_dimension_value: type: string title: First Dimension Value second_dimension_value: oneOf: - type: string - type: 'null' title: Second Dimension Value scaling_factor: type: string title: Scaling Factor additionalProperties: false type: object required: - first_dimension_value - scaling_factor title: ScalableMatrixWithUnitScalingFactor description: Configuration for a single matrix scaling factor ScalableMatrixWithTieredTierEntry: properties: tier_lower_bound: type: string title: Tier Lower Bound unit_amount: type: string title: Unit Amount additionalProperties: false type: object required: - tier_lower_bound - unit_amount title: ScalableMatrixWithTieredTierEntry description: Configuration for a single tier entry with business logic ScalableMatrixWithTieredScalingFactor: properties: first_dimension_value: type: string title: First Dimension Value second_dimension_value: oneOf: - type: string - type: 'null' title: Second Dimension Value scaling_factor: type: string title: Scaling Factor additionalProperties: false type: object required: - first_dimension_value - scaling_factor title: ScalableMatrixWithTieredScalingFactor description: Configuration for a single matrix scaling factor CumulativeGroupedBulkDimensionValue: properties: tier_lower_bound: type: string title: Tier Lower Bound description: Tier lower bound grouping_key: type: string minLength: 1 title: Grouping Key description: Grouping key value unit_amount: type: string title: Unit Amount description: Unit amount for this combination additionalProperties: false type: object required: - tier_lower_bound - grouping_key - unit_amount title: CumulativeGroupedBulkDimensionValue description: Configuration for a dimension value entry DailyCreditAllowanceMatrixValue: properties: unit_amount: type: string title: Unit Amount description: >- Credits charged per unit of usage matching the specified dimension_values dimension_values: items: oneOf: - type: string - type: 'null' type: array title: Dimension Values description: >- 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. additionalProperties: false type: object required: - unit_amount - dimension_values title: DailyCreditAllowanceMatrixValue description: Per-dimension credit price for the daily credit allowance model. ConversionRateUnitConfig: properties: unit_amount: type: string title: Unit Amount description: Amount per unit of overage additionalProperties: false type: object required: - unit_amount title: ConversionRateUnitConfig ConversionRateTieredConfig: properties: tiers: items: $ref: '#/components/schemas/ConversionRateTier' type: array title: Tiers description: >- Tiers for rating based on total usage quantities into the specified tier additionalProperties: false type: object required: - tiers title: ConversionRateTieredConfig ConversionRateTier: properties: first_unit: type: number title: First Unit description: Exclusive tier starting value last_unit: oneOf: - type: number - type: 'null' title: Last Unit description: >- Inclusive tier ending value. If null, this is treated as the last tier unit_amount: type: string title: Unit Amount description: Amount per unit of overage additionalProperties: false type: object required: - first_unit - unit_amount title: ConversionRateTier securitySchemes: APIKeyAuth: type: http description: API Keys can be issued in the Orb's web application. scheme: bearer ````