dashboard:readUser IDBilling-period options for the payment dashboard filter: every calendar month (UTC) touched
by the range, formatted Month YYYY (e.g. January 2026), oldest first. When the range
crosses a calendar year only the most recent 6 months are returned.
The range is taken from from and to when either is sent (both are then required, in order); otherwise from start_time/end_time
or period (no maximum range here); otherwise it is the current month and the 5 before it.
fromdate-timeRange start in ISO 8601. When from or to is sent, both must be sent
(400 Both from and to must be provided), and from must not be after to
(400 from cannot be after to).
todate-timeRange end in ISO 8601. Must be sent together with from.
start_timedate-timeRange start in ISO 8601 UTC format, used when neither from nor to is sent. When
start_time or end_time is sent, both must be sent (400 otherwise), and start_time
must not be after end_time (400).
end_timedate-timeRange end in ISO 8601 UTC format, used together with start_time.
periodstringPredefined period, used when none of from, to, start_time and end_time is sent.
todaylast_24_hoursyesterdaylast_7_daysthis_monthlast_monthlast_30_daysthis_quarterlast_quarterthis_yearlast_yearlast_12_monthsBilling-period filter list retrieved successfully.
HTTP status code
Response message
List of available filter options.
Array of filter options.
A single filter option with a display name and value identifier.
Unique request ID for tracking
Example
{
"status_code": 200,
"message": "Success",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"data": {
"items": [
{
"name": "January 2026",
"id": "January 2026"
},
{
"name": "February 2026",
"id": "February 2026"
},
{
"name": "March 2026",
"id": "March 2026"
}
]
}
}Was this page helpful?