Skip to main content
POST
Evaluate preview events

Authorizations

Authorization
string
header
required

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

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.

events
PreviewEvent · object[]

List of preview events to use instead of actual usage data

Required array length: 1 - 500 elements
price_evaluations
PriceEvaluationRequest · object[]

List of prices to evaluate (max 100)

Required array length: 1 - 100 elements

Response

OK

data
EvaluatePriceResourceForMultiplePrice · object[]
required