Skip to main content
GET
Retrieve Usage Record

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Response

200 - application/json

A priced usage ledger row. Read-only over the API — rows are derived from usage events by the pricing expansion, never written directly.

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
created_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
usage_event
integer | null
description
string
Maximum string length: 500
quantity
number<double>
Required range: -100000000000 < x < 100000000000
rate
number<double>
Required range: -1000000000000000 < x < 1000000000000000
pricing
enum<string>
  • COMMIT - Within commit
  • OVERAGE - Overage
Available options:
COMMIT,
OVERAGE
currency
string
Maximum string length: 3
amount
number<double>
Required range: -10000000000000 < x < 10000000000000