Get Billing Order Usages Using GET 1

Get the usage list of a billing order. Supported selectors: code, category, name.

Pre-authorized roles: Operations, Read Only

Request

URI

GET

https://{api_host}//vcp.vmware.com/api/provider/v1/billingOrders/{orderId}/usages

COPY

Path Parameters

string

orderId

Required

Billing order id

orderId example

f6bc69ec-xxxx-xxxx-xxxx-eeafc4a7e0bb

Query Parameters

string

filter

Optional

FIQL format

integer

limit

Optional

limit

integer

offset

Optional

offset

string

sort

Optional

sort

Responses

200

Usage for different product families.

| Properties                    | MSP | VELO | Rental & Others(SOV, ISV, etc) |
| ----------------------------- | --- | ---- | ------------------------------ |
| id                            |  *  |  *   |               *                |
| code                          |  *  |  *   |               *                |
| category                      |  *  |  *   |               *                |
| name                          |  *  |  *   |               *                |
| customerNumber                |  *  |  *   |               *                |
| customerName                  |  *  |  *   |               *                |
| quantity                      |  *  |  *   |               *                |
| siteId                        |     |      |               *                |
| siteName                      |     |      |               *                |
| ppu                           |     |      |               *                |
| points                        |     |      |               *                |
| uom                           |     |      |               *                |
| unitPrice                     |  *  |  *   |                                |
| listPrice                     |  *  |  *   |                                |
| discount                      |  *  |  *   |                                |
| sellingPrice                  |  *  |  *   |                                |
| metadata.inMinCommit          |  *  |      |               *                |
| metadata.minQuantity          |     |      |               *                |
| metadata.comment              |     |      |               *                |
| metadata.readOnly             |     |      |               *                |
| metadata.clusterUsages        |     |      |               *                |
| metadata.priceDetail          |     |      |               *                |
| metadata.subscriptionId       |  *  |      |                                |
| metadata.proformaNumber       |  *  |      |                                |
| metadata.invoiceNumber        |  *  |      |                                |
| metadata.sid                  |     |  *   |                                |
| metadata.orderNumber          |     |  *   |                                |

Returns PageOfUsage of type(s) application/json

{
    "content": [
        {
            "id": "c301189b-xxxx-xxxx-xxxx-9e175f966c18",
            "code": "VMW-VSANV2-STD-C",
            "category": "Cloud Infrastructure and Management",
            "name": "VMware Virtual SAN Standard",
            "siteId": "5ce44045-xxxx-xxxx-xxxx-6c5a1f54ad88",
            "siteName": "my_site",
            "customerNumber": 1111111111,
            "customerName": "Genie Tenant",
            "quantity": 10,
            "ppu": 3,
            "points": 30,
            "uom": "GB vRAM",
            "unitPrice": "number",
            "listPrice": "number",
            "discount": "number",
            "sellingPrice": "number",
            "metadata": {
                "inMinCommit": true,
                "minQuantity": "number",
                "comment": "comment",
                "readOnly": false,
                "clusterUsages": [
                    {
                        "clusterId": "cluster-test",
                        "quantity": 1
                    }
                ],
                "priceDetail": {
                    "tieredPriceDetails": [
                        {
                            "unitRange": "0-100",
                            "ppu": 3,
                            "quantity": 100,
                            "split": 0.5,
                            "points": 150
                        }
                    ]
                },
                "subscriptionId": "Invalid for Rental",
                "proformaNumber": "Invalid for Rental",
                "invoiceNumber": "Invalid for Rental",
                "sid": "Invalid for Rental",
                "orderNumber": "Invalid for Rental"
            }
        }
    ],
    "total": 1
}

array of Usage

content

Optional

content

integer As int64 As int64

total

Optional

total

400

Bad Request

Operation doesn't return any data structure

401