Skip to main content
GET
Retrieve Usage Event

Path Parameters

id
integer
required

Response

200 - application/json

A reported usage fact — the client write path. The server either prices its quantity or accepts its raw dollar amount, then expands it into ledger rows (records).

id
integer
required
read-only
performance_obligation
integer
required
obligation_name
string
required
read-only
contract
integer
required
read-only
contract_name
string
required
read-only
contract_number
string
required
read-only
client_name
string
required
read-only
usage_date
string<date>
required
records
object[]
required
read-only
created_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
description
string
Maximum string length: 500
input_type
enum<string>

Whether the event reports units to rate or a raw dollar amount.

  • QUANTITY - Quantity
  • DOLLARS - Dollar amount
Available options:
QUANTITY,
DOLLARS
quantity
number<double>
Required range: -100000000000 < x < 100000000000
input_amount
number<double>

Direct billed amount for dollar events; negative values correct prior consumption.

Required range: -10000000000000 < x < 10000000000000
currency
string
Maximum string length: 3