Generate a Services Usage Report

You view your monthly VMware Cloud services usage for your organization in the form of a consolidated billing report. You can generate reports for current accrued costs and charges for up to six months.

Prerequisites

You have the Provider Administrator, the Provider Billing User, or the Customer Administrator role in your VMware Cloud Partner Navigator organization.
You have at least one active cloud service in your organization.
Obtain an access token from your organization and set it as the csp-auth-token request header. See Using VMware Cloud Partner Navigator APIs.

Procedure

Enter the ID of the organization for which you want to generate the aggregated services usage report and run a GET request.
```
GET https://console.navigator.vmware.com/cphub/api/billing/v1/orgs/org_ID/usage-report
```
(Optional) Specify the startTime and endTime input parameters in UNIX epoch time to filter the time period for which to obtain the raw usage report.
```
GET https://console.navigator.vmware.com/cphub/api/billing/v1/orgs/org_ID/usage-report?startTime=epoch_timestamp&endTime=epoch_timestamp
```
Note: Values given for startTime and endTime are rounded off to the first and last days of the nearest month.
(Optional) Generate a billing report for a customer organization by specifying the tenantId input parameter.
```
GET https://console.navigator.vmware.com/cphub/api/billing/v1/orgs/org_ID/usage-report?tenantId=tenantId
```
Note: The customer organization must link to the provider organization.

You receive a usage report scoped within that customer organization.

Results

The response returns raw usage billing data for the services in the specified organization and timeframe.

Example: View Customer Usage Report

This example generates a raw usage report for a selected customer.

Generate the raw usage report.

GET https://console.navigator.vmware.com/cphub/api/billing/v1/orgs/00dcd47b-867d-46a1-b5ac-c9c22a4427cb/usage-report?startTime=1536856769&endTime=1538411969&tenantId=73338bcc-17e0-4480-9d25-f654532a1ee0

You receive a response with the raw usage data from the specified organization and time period.

Status 200 OK
[
  {
    "createTimestamp": 1568178851354,
    "updateTimestamp": 1568180410978,
    "orgId": "...",
    "orgName": "Coke",
    "services": [
      {
        "serviceDefId": "...",
        "serviceName": "VMware Cloud on AWS",
        "serviceDescription": "VMware Cloud on AWS - prod",
        "serviceUsageAmount": 0.0,
        "serviceBillableUsageAmount": 0.0,
        "subscriptions": [
          {
            "sid": "...",
            "subscriptionUuid": "...",
            "skuData": {
              "skus": [],
              "pageSize": 0
            },
            "subscriptionStartTime": 1528386976000,
            "subscriptionEndTime": 0,
            "anniversaryBillingTime": 0,
            "status": "ACTIVE",
            "subscriptionType": "ON_DEMAND"
          }
        ]
      },
      {
        "serviceDefId": "...",
        "serviceName": "VMware Log Intelligence",
        "serviceDescription": "log-intelligence",
        "serviceUsageAmount": 0.0,
        "serviceBillableUsageAmount": 0.0,
        "subscriptions": [
          {
            "sid": "...",
            "subscriptionUuid": "...",
            "skuData": {
              "skus": [],
              "pageSize": 0
            },
            "subscriptionStartTime": 1534465763000,
            "subscriptionEndTime": 0,
            "anniversaryBillingTime": 0,
            "status": "ACTIVE",
            "subscriptionType": "ON_DEMAND"
          }
        ]
      }
    ],
    "orgUsageAmount": 0.0,
    "orgBillableUsageAmount": 0.0
  }
]

What to do next

Download the generated billing statement.