query · Module: Billing · Requires billing:read
Arguments
Returns
MeterList!
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 Meters($limit: Int) {
meters(limit: $limit) {
data {
id
object
name
status
livemode
created
updated
key
source {
event
reported
}
aggregation
value_path
unit
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"meters": {
"data": [
{
"id": "mtr_1a2B3c",
"object": "meter",
"name": "Example",
"status": "active",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"key": "signature",
"source": {
"event": "example",
"reported": true
},
"aggregation": "count",
"value_path": "example",
"unit": "kg"
}
],
"has_more": true
}
}
}
List meters
query Meters($limit: Int) {
meters(limit: $limit) {
data {
id
object
name
status
livemode
created
updated
key
source {
event
reported
}
aggregation
value_path
unit
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"meters": {
"data": [
{
"id": "mtr_1a2B3c",
"object": "meter",
"name": "Example",
"status": "active",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"key": "signature",
"source": {
"event": "example",
"reported": true
},
"aggregation": "count",
"value_path": "example",
"unit": "kg"
}
],
"has_more": true
}
}
}
query · Module: Billing · Requires billing:read
| Argument | Type | Description |
|---|---|---|
status | String | Filter by status. |
createdGte | Int | Filter by created gte. |
createdLte | Int | Filter by created lte. |
limit | Int | Page size, 1–100 (default 10). |
startingAfter | ID | Cursor: return objects after this ID. |
endingBefore | ID | Cursor: return objects before this ID. |
MeterList!
| Field | Type |
|---|---|
data | [Meter!]! |
has_more | Boolean |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query Meters($limit: Int) {
meters(limit: $limit) {
data {
id
object
name
status
livemode
created
updated
key
source {
event
reported
}
aggregation
value_path
unit
}
has_more
}
}
{
"limit": 10
}
{
"data": {
"meters": {
"data": [
{
"id": "mtr_1a2B3c",
"object": "meter",
"name": "Example",
"status": "active",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"key": "signature",
"source": {
"event": "example",
"reported": true
},
"aggregation": "count",
"value_path": "example",
"unit": "kg"
}
],
"has_more": true
}
}
}