[{"label":"Latest (1.0.0)","version":"latest"}]
cost-and-usage-management
Get Usage Overview
DescriptionThe API allows you to get a summary of the usage information for a given service identifier and metric identifier in an organization. The API returns the total usage, commitment, and overage values based on the latest updated usage information. You can specify an end date to filter the usages by their latest update time prior to the time specified. If you do not specify an end date, the API will use the latest update time as the end date.
Request
URLURL
https://console.cloud.vmware.com/commerce/cost-and-usage/api/{org_id}/usage/overview
Path Parameters
Path Parameters
string
org_id
Required
Unique identifier (GUID) of the organization
Query Parameters
Query Parameters
string
end_date
Optional
Filtering criteria based on latest update time (yyyy-mm-dd)
string
locale
Optional
Locale with language preference (e.g. en_US)
string
metric_id
Required
Unique identifier of the metric
string
service_definition_id
Required
Unique identifier of the service
Response
Response
Response BodyResponse Body
200 OK
Returns
UsageOverviewResponse
of type application/json
{
"metadata": {
"charge_attributes": {
"key": "string"
},
"display_name": "string",
"metric_id": "string",
"service_definition_id": "string",
"unit_of_measure_display_name": "string"
},
"usages": [
{
"commitment": 0,
"last_updated": "string",
"overage": 0,
"partner_id": "string",
"seller": "string",
"seller_id": "string",
"status": "OVER_COMMITMENT",
"subscriptions": [
{
"billing_engine_subscription_id": "string",
"subscription_id": "string"
}
],
"usage": 0
}
]
}
Errors
ApiError
400
Bad Request
401
Unauthorized
403
Forbidden
Code Samples
cURL Command
curl https://console.cloud.vmware.com/commerce/cost-and-usage/api/{org_id}/usage/overview?metric_id=string&service_definition_id=string
[{"label":"Latest (1.0.0)","version":"latest"}]
cost-and-usage-management
