Sign in

v52

latestOpenAPI 3.0.1AGPL-3.0raw.githubusercontent.com2026-08-01255473862.7 KB
Subscriptions

Get usage by subscription

Use when showing usage for a subscription (e.g. in a portal or for overage checks). Supports time range and filters.

post/subscriptions/usage

Request body

end_timestring date-time
lifetime_usageboolean
start_timestring date-time
subscription_idstring required

Example request

{
  "end_time": "2024-03-20T00:00:00Z",
  "start_time": "2024-03-13T00:00:00Z",
  "subscription_id": "123"
}

Response

OK

amountnumber
commitment_amountnumber
commitment_utilizednumber

Amount of commitment used

currencystring
display_amountstring
end_timestring date-time
has_overageboolean

Whether any usage exceeded commitment

overage_amountnumber

Amount charged at overage rate

overage_factornumber
start_timestring date-time