query · Module: Billing · Requires billing:read
Arguments
Returns
UsageRecord!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
query UsageRecord($id: ID!) {
usageRecord(id: $id) {
id
object
livemode
created
updated
meter
account
quantity
occurred_at
subject {
type
id
}
source
event
}
}
{
"id": "ur_1a2B3c"
}
{
"data": {
"usageRecord": {
"id": "ur_1a2B3c",
"object": "usage_record",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"meter": "example",
"account": "acct_ada",
"quantity": 1.5,
"occurred_at": "2026-10-07T09:00:00Z",
"subject": {
"type": "example",
"id": "obj_1a2B3c"
},
"source": "event",
"event": "example"
}
}
}
Retrieve a UsageRecord
query UsageRecord($id: ID!) {
usageRecord(id: $id) {
id
object
livemode
created
updated
meter
account
quantity
occurred_at
subject {
type
id
}
source
event
}
}
{
"id": "ur_1a2B3c"
}
{
"data": {
"usageRecord": {
"id": "ur_1a2B3c",
"object": "usage_record",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"meter": "example",
"account": "acct_ada",
"quantity": 1.5,
"occurred_at": "2026-10-07T09:00:00Z",
"subject": {
"type": "example",
"id": "obj_1a2B3c"
},
"source": "event",
"event": "example"
}
}
}
query · Module: Billing · Requires billing:read
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
UsageRecord!
| Field | Type |
|---|---|
id | String! |
object | UsageRecordObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
meter | String! |
account | String! |
quantity | Float! |
occurred_at | String! |
subject | UsageRecordSubject |
properties | JSON |
source | UsageRecordSource |
event | String |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query UsageRecord($id: ID!) {
usageRecord(id: $id) {
id
object
livemode
created
updated
meter
account
quantity
occurred_at
subject {
type
id
}
source
event
}
}
{
"id": "ur_1a2B3c"
}
{
"data": {
"usageRecord": {
"id": "ur_1a2B3c",
"object": "usage_record",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"meter": "example",
"account": "acct_ada",
"quantity": 1.5,
"occurred_at": "2026-10-07T09:00:00Z",
"subject": {
"type": "example",
"id": "obj_1a2B3c"
},
"source": "event",
"event": "example"
}
}
}