query · Module: Billing
Arguments
Returns
UsageSummariesResult!
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 UsageSummaries {
usageSummaries {
account
period
meters {
meter
quantity
amount {
amount
currency
}
included_used
}
}
}
{}
{
"data": {
"usageSummaries": {
"account": "acct_ada",
"period": "example",
"meters": [
{
"meter": "example",
"quantity": 1.5,
"amount": {
"amount": 1299,
"currency": "usd"
},
"included_used": 1.5
}
]
}
}
}
Usage summary per meter
query UsageSummaries {
usageSummaries {
account
period
meters {
meter
quantity
amount {
amount
currency
}
included_used
}
}
}
{}
{
"data": {
"usageSummaries": {
"account": "acct_ada",
"period": "example",
"meters": [
{
"meter": "example",
"quantity": 1.5,
"amount": {
"amount": 1299,
"currency": "usd"
},
"included_used": 1.5
}
]
}
}
}
query · Module: Billing
| Argument | Type | Description |
|---|---|---|
account | String | Filter by account. |
period | String | Filter by period. |
UsageSummariesResult!
| Field | Type |
|---|---|
account | String |
period | String |
meters | [UsageSummariesResultMetersItem!] |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
query UsageSummaries {
usageSummaries {
account
period
meters {
meter
quantity
amount {
amount
currency
}
included_used
}
}
}
{}
{
"data": {
"usageSummaries": {
"account": "acct_ada",
"period": "example",
"meters": [
{
"meter": "example",
"quantity": 1.5,
"amount": {
"amount": 1299,
"currency": "usd"
},
"included_used": 1.5
}
]
}
}
}