API documentation
Integrations
Analytics
Billable events
Companies
Coupons > Promotion codes
Custom properties
Customers
Customers > Credits
Customers > Payment methods
Integrations
Invoices
Invoices > Transactions
Invoicing entities
Organisations
Payments
Price configurations
Products
Quotes
Subscriptions
- GETGet subscriptions
- GETGet subscription
- GETGet subscription phases
- GETGet subscription phase
- POSTCreate subscription update
- POSTCreate subscription updates
- POSTCreate subscription
- PUTUpdate subscription
- POSTActivate subscription
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- POSTRefresh seat products
- POSTRefresh subscriptions
- POSTReinstate subscription
- POSTTransition subscription to next phase
Third-party apps
Wallets
Billable events
Simulate billable event prices
Simulate prices for a single billable event without ingesting it.
POST
/
v1
/
events
/
simulate-prices
curl --request POST \
--url https://ingest.hyperline.co/v1/events/simulate-prices \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"event_type": "api_call",
"record": {
"id": "D32NAA8",
"durationInMs": 32,
"isVerified": true
},
"customer_id": "cus_CrqwefTRWBWRT",
"timestamp": "2024-12-20T16:04:11Z"
}'
{
"id": "cal_1234567890",
"result": [
{
"customer_id": "<string>",
"subscription_id": "<string>",
"product_id": "itm_AweveQEoewer",
"price_group": {
"id": "grp_QalW2vTAdkR6IY",
"name": "mastercard"
},
"amount_excluding_tax": 10000,
"tax_amount": 2000,
"total_amount": 12000,
"currency": "EUR"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Hyperline ID of the product.
Example:
"itm_AweveQEoewer"
Hyperline ID of the subscription.
Example:
"sub_QalW2vTAdkR6IY"
Whether to include amounts with tax
Example:
true
Body
application/json
Event payload
The body is of type object
.
Response
200 - application/json
Event prices simulated
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://ingest.hyperline.co/v1/events/simulate-prices \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"event_type": "api_call",
"record": {
"id": "D32NAA8",
"durationInMs": 32,
"isVerified": true
},
"customer_id": "cus_CrqwefTRWBWRT",
"timestamp": "2024-12-20T16:04:11Z"
}'
{
"id": "cal_1234567890",
"result": [
{
"customer_id": "<string>",
"subscription_id": "<string>",
"product_id": "itm_AweveQEoewer",
"price_group": {
"id": "grp_QalW2vTAdkR6IY",
"name": "mastercard"
},
"amount_excluding_tax": 10000,
"tax_amount": 2000,
"total_amount": 12000,
"currency": "EUR"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.