POST
/
v1
/
events
/
simulate-prices

Authorizations

​
Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
product_id
string

Hyperline ID of the product.

​
subscription_id
string

Hyperline ID of the subscription.

​
include_tax
boolean | null

Whether to include amounts with tax

Body

application/json
​
event_type
string
required

Type corresponding to the event. When creating a dynamic product, this type will be used to map the related events to specific prices.

​
record
object
required

Payload of the event containing an ID and any additional metadata.

​
customer_id
string

Hyperline ID or external ID of the existing customer.

​
timestamp
string

UTC date time string in the ISO 8601 format, or milliseconds since the epoch. The event timestamp is used to retrieve the events related to a specific billing period.

Response

200 - application/json
​
id
string
required

ID of the calculation.

​
result
object[]
required

Was this page helpful?

Ingest and calculate billable event pricesGet companies