Ingest billable event

Ingest a new billable event. This endpoint is idempotent, an event with the same id will be updated if it already exists.

POST /v1/events

Ingest billable event

cURL

curl --request POST \
  --url https://ingest.hyperline.co/v1/events \
  --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
  }
}
'

Authorizations

Authorization · string · header · required

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

Query Parameters

with_price_calculation · boolean | null

Whether to simulate prices for the event. Will be received in webhooks.

Example:

true

Body

application/json

Event payload

customer_id · string · required

Hyperline ID or external ID of the existing customer.

Example:

"cus_CrqwefTRWBWRT"

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.

Minimum string length: 1

Example:

"api_call"

timestamp · string<date-time> · 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.

Example:

"2024-12-20T16:04:11Z"

record · object · required

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

Show child attributes

Example:

{
  "id": "D32NAA8",
  "durationInMs": 32,
  "isVerified": true
}

Response

201

Event ingested