Skip to main content
POST
Ingest billable events

Authorizations

Authorization
string
header
required

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

Body

application/json

Events payload

Required array length: 1 - 5000 elements
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.

Example:

Response

201 - application/json

Events ingested

events_created
object[]
required
events_failed
object[]
required