Billable events
simulate billable event prices
Simulate prices for a single billable event. This endpoint is in beta, please contact us if you want to know more.
POST
/
v1
/
events
/
simulate-prices
Authorizations
Authorization
string
headerrequiredBearer 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.
Body
application/json
customer_id
string
requiredHyperline ID or external ID of the existing customer.
event_type
string
requiredType corresponding to the event. When creating a dynamic product, this type will be used to map the related events to specific prices.
timestamp
string
requiredUTC 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.
record
object
requiredPayload of the event containing an ID and any additional metadata.
Response
200 - application/json
id
string
requiredId of the calculation.
result
object[]
requiredWas this page helpful?