Skip to main content
POST
Evaluate price

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

price_id
string
required

Body

application/json
timeframe_start
string<date-time>
required

The inclusive lower bound for event timestamps

timeframe_end
string<date-time>
required

The exclusive upper bound for event timestamps

customer_id
string | null

The ID of the customer to which this evaluation is scoped.

external_customer_id
string | null

The external customer ID of the customer to which this evaluation is scoped.

filter
string | null

A boolean computed property used to filter the underlying billable metric

Example:

"my_numeric_property > 100 AND my_other_property = 'bar'"

grouping_keys
string[]

Properties (or computed properties) used to group the underlying billable metric

Examples:
metric_parameter_overrides
Metric Parameter Overrides · object | null

Optional overrides for parameterized billable metric parameters. If the metric has parameter definitions and no overrides are provided, defaults will be used.

Response

OK

data
EvaluatePriceGroup · object[]
required