Skip to main content
POST
cURL

Headers

X-Valyx-Signature
string
required

Auth key to authenticate the request

Body

application/json
buyerId
string
required

Unique identifier of the buyer associated with this usage event

Example:

"buyer_12345"

eventTimeStamp
integer
required

Unix timestamp in milliseconds representing when the usage occurred

Example:

1755079200000

tags
object
required

Custom key-value tags associated with this usage

Example:
metrics
object[]
required

List of usage metrics for this event

usageReferenceId
string
required

A unique reference ID for tracking this usage event across systems

Example:

"usage_ref_98765"

contractId
string

Identifier of the contract under which the usage is recorded

Example:

"contract_67890"

eventId
string

Optional unique ID for this usage event, useful for idempotency

Example:

"event_abc123"

metadata
object

Optional metadata for storing extra key-value information about the usage event.

Example:

Response

200 - application/json

Success

error
string
message
string
data
object