POST
/
v1
/
events
/
prices
curl --request POST \
  --url https://ingest.hyperline.co/v1/events/prices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer_id": "cus_CrqwefTRWBWRT",
  "event_type": "api_call",
  "timestamp": "2024-12-20T16:04:11Z",
  "record": {
    "id": "D32NAA8",
    "durationInMs": 32,
    "isVerified": true
  }
}'
{
  "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

Authorization
string
header
required

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 payload
customer_id
string
required

Hyperline ID or external ID of the existing customer.

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.

timestamp
string
required

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.

record
object
required

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

Response

201 - application/json
Event prices calculated and ingested
id
string
required

ID of the calculation.

result
object[]
required