View Subscriptions

As a cloud provider, you can view the term subscriptions for services entitled to your organization and linked customer organizations using the billing & subscription API.

Prerequisites

  • You have the Provider Administrator , Provider Operations Administrator , or Provider Billing User role in your VMware Cloud Partner Navigator provider 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 your organization and run a GET request. 
    GET https://console.navigator.vmware.com/cphub/api/billing/v1/orgs/org_ID/subscriptions

    You can specify a customer organization using the tenantId input parameter. If you leave tenantId unspecified, usage reports for all customers in the provider organization are downloaded.

Results

The response returns information about the service subscriptions of the specified organization.

Example: Service Subscriptions for a Customer

This example retrieves the service subscriptions of a given customer organization.

Get a list of the service subscriptions entitled to the organization.
GET http://console.navigator.vmware.com/cphub/api/billing/v1/orgs/5c2f361d-aba1-4534-82f7-88096fa74f3f/subscriptions?tenantId=73338bcc-17e0-4480-9d25-f654532a1ee0
The response returns information about the service subscriptions of the specified organization.
 [
  {
    "createTimestamp": 1568093887019,
    "updateTimestamp": 1569846392481,
    "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": [
                {
                  "skuDescription": "VMware Cloud on Amazon Web Services",
                  "crossReferenceSku": "...",
                  "geo": "US",
                  "regionCode": "A1",
                  "currency": "USD",
                  "paymentType": "",
                  "unitPrice": "51987.0",
                  "productFamily": "VMC-AWS",
                  "customerSegment": "COMMERCIAL",
                  "offerInfo": {
                    "offerName": "VMware Cloud on AWS",
                    "version": "1.0",
                    "commitmentTerm": "12",
                    "commitmentTermUOM": "MONTHS",
                    "serviceType": "VMC-AWS",
                    "serviceTypeDescription": "VMware Cloud on Amazon Web Services",
                    "customerSegment": "COMMERCIAL",
                    "geo": "US",
                    "regionCode": "A1",
                    "currency": "USD",
                    "quantity": 1
                  },
                  "usage": [],
                  "totalUsageQuantity": 0.0,
                  "totalCommitQuantity": 0.0,
                  "totalBillableUsageQuantity": 0.0
                }
              ],
              "pageSize": 1
            },
            "subscriptionStartTime": 1523123678000,
            "subscriptionEndTime": 1554573278000,
            "anniversaryBillingTime": 0,
            "status": "ACTIVE",
            "subscriptionType": "TERM"
          }
        ]
      },
      {
        "serviceDefId": "...",
        "serviceName": "VMware Cost Insight",
        "serviceDescription": "Cost_Insight",
        "serviceUsageAmount": 0.0,
        "serviceBillableUsageAmount": 0.0,
        "subscriptions": []
      },
      {
        "serviceDefId": "...",
        "serviceName": "VMware Log Intelligence",
        "serviceDescription": "log-intelligence",
        "serviceUsageAmount": 0.0,
        "serviceBillableUsageAmount": 0.0,
        "subscriptions": []
      }
    ],
    "orgUsageAmount": 0.0,
    "orgBillableUsageAmount": 0.0
  }
]