VMware Cloud Provider Commerce Portal - Aggregator API Documentation Data Structures
Request to create a contract
{
"contractSKUId": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
"serviceProviderContact": "[email protected]",
"licenseContact": "[email protected]",
"aggregatorContact": "[email protected]",
"systemContact": "[email protected]",
"serviceProviderId": "33f574a8-xxxx-xxxx-xxxx-b10700000008",
"bolDate": "2022-03-21",
"currency": "USD",
"billingOrderPreference": "string",
"vmwarePurchaseOrder": "PO-100000",
"fillPurchaseOrderInMBO": "boolean",
"billToAccountId": "533ea6cb-xxxx-xxxx-xxxx-b10700000008",
"entitlementAccount": 111111,
"term": "Required for CUSTOM/PREPAY, ignored for PAY-GO",
"minCommits": [
"number"
],
"prepayment": "Required for PREPAY, ignored for PAY-GO/CUSTOM",
"triggerPoint": "Optional for PREPAY, ignored for PAY-GO/CUSTOM",
"discount": "Required for CUSTOM/PREPAY, ignored for PAY-GO",
"spf": "Required for CUSTOM/PREPAY, ignored for PAY-GO",
"comment": "created by [email protected]",
"threshold": 900
}
contractSKUId
Cloud service provider contact
Required for RENTAL, SOV and LPCAAS
aggregatorContact
VMware contact
Cloud service provider
Start date
currency
Order preference
Purchase Order with VMware
Autofill purchase order number into monthly billing order
Bill-to location
entitlementAccount
Term (in Months)
Minimum commits. Each element is the minimum commit for each month. If the request start date is the first day of the month, the length of minimum commits equals to term, otherwise the length of minimum commits equals to the term plus one. E.g. 1: Start date is 2022-03-01 and term is 12, then the minimum commits are [10,10,10,10,10,10,10,10,10,10,10,10]. E.g. 2: Start date is 2022-03-21 and term is 12, then the minimum commits are [3,10,10,10,10,10,10,10,10,10,10,10,7]. Minimum commits are not required for VELO.
Total prepaid, must be greater than or equal to the sum of minimum commits
Optional. Notify when balance is below trigger point
discount
spf
comment
Usage threshold, required for MSP contract
Request to downgrade a contract
{
"contractSKUId": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
"effectiveDate": "2023-03-01",
"comment": "Lower Monthly Commit"
}
New contract SKU
effectiveDate
comment
Request to terminate a contract
{
"effectiveDate": "2023-03-01",
"comment": "terminated by [email protected]",
"reason": "Service Provider Bankruptcy"
}
Terminate date
comment
Service Provider Bankruptcy,Aggregator Swap,Service Provider Delinquent,COVID Impact,Partner Connect Fee,Competitor Offering,Merger and Acquisition
Request to top up a contract
{
"prepayment": 240,
"term": 12,
"burnDownSchedule": [
20,
20,
20,
20,
20,
20,
20,
20,
20,
20,
20,
20
],
"comment": "top up by [email protected]",
"vmwarePurchaseOrder": "PO-100000"
}
Top-Up Amount
Term (in Months), must be greater than or equal to the contract term
Each element is a burndown schedule for each month. Only the burndown schedule since the current month can be changed. The length of the burndown schedule is the request term. Example: The contract burndown schedule is [10,10,10,10,10,10,10,10,10,10,10,10], start date is 2022-01-01, term is 12, and current date is 2022-03-01. Case 1: Request term is the same as original term, top up 20 from 2022-03 to 2022-12, then the burndown schedule is [10,10,20,20,20,20,20,20,20,20,20,20]. Case 2: Request to extend two months, top up 20 from 2022-03 to 2023-02, then the burndown schedule is [10,10,20,20,20,20,20,20,20,20,20,20,20,20].
comment
Purchase Order with VMware
Request to update a contract
{
"serviceProviderContact": "[email protected]",
"licenseContact": "[email protected]",
"aggregatorContact": "[email protected]",
"billingOrderPreference": "string",
"vmwarePurchaseOrder": "PO-100000",
"fillPurchaseOrderInMBO": "boolean",
"billToAccountId": "533ea6cb-xxxx-xxxx-xxxx-b10700000008",
"entitlementAccount": 111111
}
Cloud service provider contact
Valid for RENTAL, SOV and LPCAAS
aggregatorContact
Order preference
Purchase Order with VMware
Autofill purchase order number into monthly billing orders
Bill-to location
Entitlement account number
Request to upgrade a contract
{
"contractSKUId": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
"effectiveDate": "2023-03-01",
"comment": "Higher Monthly Commit"
}
New contract SKU
effectiveDate
comment
{
"id": "56929513-xxxx-xxxx-xxxx-513800000000",
"name": "Rental Commercial",
"code": "RENTAL",
"description": "Rental (also known as License Rental)",
"type": "RENTAL"
}
id
name
code
description
type
firstName
lastName
Request to approve a monthly billing order
{
"serviceProviderPurchaseOrder": "PO-100000",
"vmwarePurchaseOrder": "PO-100000",
"billingOrderPreference": "string",
"comment": "approved by [email protected]"
}
Purchase order from cloud services provider of the billing order
Purchase Order with VMware
billingOrderPreference
comment
{
"type": "UserToken"
}
type
{
"accountNumber": 10001,
"location": "location-100010"
}
Bill-to account number
location
{
"id": "533ea6cb-xxxx-xxxx-xxxx-b10700000008",
"accountNumber": 10001,
"siteId": 1000001,
"location": "location-100010",
"countryRegion": "US"
}
id
Bill-to account number
siteId
Bill-to location
countryRegion
{
"user": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"createdTime": "2023-03-01T08:14:56Z",
"content": "approved by [email protected]"
}
createdTime
content
{
"clusterId": "cluster-test",
"quantity": 1
}
Cluster id of the cluster usage
Quantity of the cluster usage
Request to add a comment to a monthly billing order
{
"comment": "approved by [email protected]"
}
comment
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111
},
"aggregatorContact": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"serviceProviderContact": {
"firstName": "James",
"lastName": "Smith",
"email": "[email protected]"
},
"systemContact": {
"firstName": "Maria",
"lastName": "Williams",
"email": "[email protected]"
},
"licenseContact": {
"firstName": "Ava",
"lastName": "Brown",
"email": "[email protected]"
},
"eolDate": "2023-03-20",
"bolDate": "2022-03-21",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"contractNumber": 111111,
"region": "AMER",
"term": 12,
"graceTerm": 1,
"currency": "USD",
"contractId": 1111,
"discount": 20,
"spf": "SPF123",
"vmwarePurchaseOrder": "PO-100000",
"billingOrderPreference": "ONLINE",
"billToAccount": {
"accountNumber": 10001,
"location": "location-100010"
},
"entitlementAccount": 111111,
"sellingPricePerPoint": 0.88,
"fillPurchaseOrderInMBO": "boolean"
}
id
End date of the contract
Begin date of the contract
status
contractReferenceNumber
contractNumber
Region of the cloud services provider
Term of the contract(in months)
Grace term(in months) when it's a PAY-GO contract
currency
Contract id
discount
Contract SPF
Purchase order with VMware
Billing order preference
Entitlement account
Selling price per point
Autofill purchase order number into monthly billing orders
{
"id": "f8b83357-xxxx-xxxx-xxxx-8366e586c8f9",
"status": "PENDING_APPROVAL",
"requestType": "DOWNGRADE",
"requestContractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"effectiveDate": "2023-03-01",
"createdTime": "2023-03-01T07:36:00.396Z",
"token": "C-100002-00012-2303-0000101"
}
Contract downgrade request id
Current status
requestType
effectiveDate
createdTime
token
{
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
}
code
contractType
{
"id": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
"code": "VSPP3-1800-C",
"bolDate": "2010-10",
"eolDate": "2030-10",
"contractType": "PAY-GO",
"minCommit": 1800,
"term": 12,
"discount": "number",
"commitType": "MONTHLY",
"commitValue": "integer"
}
id
code
Begin month
End month
contractType
Minimum commit
term
discount
SKU commit type
SKU commit value
{
"id": "f8b83357-xxxx-xxxx-xxxx-8366e586c8f9",
"status": "PENDING_APPROVAL",
"requestType": "TERMINATE",
"requestContractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"effectiveDate": "2023-03-01",
"createdTime": "2023-03-01T07:36:00.396Z",
"token": "C-100002-00012-2303-0000101"
}
Contract terminate request id
Current status
requestType
effectiveDate
createdTime
token
{
"id": "f8b83357-xxxx-xxxx-xxxx-8366e586c8f9",
"status": "PENDING_APPROVAL",
"requestType": "TOPUP",
"requestContractSKU": {
"code": "VSPP3-PREPAY-C",
"contractType": "PRE-PAY",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"effectiveDate": "2023-03-01",
"createdTime": "2023-03-01T07:36:00.396Z",
"token": "C-100002-00012-2303-0000101",
"vmwarePurchaseOrder": "PO-100000",
"term": 12,
"prepayment": 240,
"burnDownSchedule": [
20,
20,
20,
20,
20,
20,
20,
20,
20,
20,
20,
20
]
}
Contract top up request id
Current status
Current request type
effectiveDate
createdTime
token
Purchase Order with VMware
term
Total prepaid
burnDownSchedule
{
"id": "f8b83357-xxxx-xxxx-xxxx-8366e586c8f9",
"status": "PENDING_EFFECTIVE_DATE",
"requestType": "UPGRADE",
"requestContractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"effectiveDate": "2023-03-01",
"createdTime": "2023-03-01T07:36:00.396Z",
"token": "C-100002-00012-2303-0000101"
}
Contract upgrade request id
Current status
requestType
effectiveDate
createdTime
token
{
"contract": {
"contractNumber": 111111,
"contractReferenceNumber": "AMER1111RENTAL",
"currency": "USD"
},
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
},
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca2",
"dealNumber": 20001,
"productSKU": "VMW-VSANV2-STD-C",
"productCategory": "Cloud Infrastructure and Management",
"projectedDealValue": 10000,
"status": "CLOSED_WON",
"extendStatus": "NOT_EXTENDED",
"creationDate": "2022-08-03",
"expirationDate": "2023-01-30",
"expectedCloseDate": "2022-10-23",
"closeDate": "2022-11-01",
"fiscalQuarter": "Q3FY2022",
"serviceProviderContact": "[email protected]",
"aggregatorSalesContactLead": "[email protected]",
"aggregatorManager": "[email protected]",
"promotionEvent": "SALES_CAMPAIGN"
}
id
Deal number
productSKU
Product category
Projected deal value
Enum: [DRAFT, PENDING_APPROVE, PENDING_REVISION, OPPORTUNITY, CLOSED_WON, CLOSED_LOST, CLOSED_EXPIRED, CLOSED_DENIED, CLOSED_ABANDONED, CLOSED_CONTRACT_TERMINATED, CLOSED_AGGREGATOR_SWAPPED, CLOSED_AS_LOST_PRODUCT_ACCESS]
Extend status
creation date
Expiration date
Expected close date
Close date
The fiscal quarter of VMware
Cloud services provider contact
Aggregator sales contact lead
Aggregator manager
Promotion event. Enums: [Sales Campaign, Webinar, Training, Partner Meeting, Other]
{
"contractNumber": 111111,
"contractReferenceNumber": "AMER1111RENTAL",
"currency": "USD"
}
contractNumber
contractReferenceNumber
currency
{
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
}
name
prmId
countryRegion
type
userToken
type
userToken
Valid for RENTAL and SOV
{
"firstName": "Ava",
"lastName": "Brown",
"email": "[email protected]"
}
firstName
lastName
{
"inMinCommit": true,
"minQuantity": "number",
"comment": "comment",
"readOnly": "boolean",
"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",
"cspOrgId": "Invalid for Rental"
}
Flag to indicate whether it will be counted in minimum commitment
Minimum quantity of usage if the product's usage is reported
Comment to explain why usage is manually changed
readOnly
Subscription id
Proforma number
Invoice number
Order sid
Order number
CSP organization id
{
"content": [
{
"id": "56929513-xxxx-xxxx-xxxx-513800000000",
"name": "Rental Commercial",
"code": "RENTAL",
"description": "Rental (also known as License Rental)",
"type": "RENTAL"
}
],
"total": 1
}
total
{
"content": [
{
"id": "533ea6cb-xxxx-xxxx-xxxx-b10700000008",
"accountNumber": 10001,
"siteId": 1000001,
"location": "location-100010",
"countryRegion": "US"
}
],
"total": 1
}
total
{
"content": [
{
"user": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"createdTime": "2023-03-01T08:14:56Z",
"content": "approved by [email protected]"
}
],
"total": 1
}
total
{
"content": [
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111
},
"aggregatorContact": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"serviceProviderContact": {
"firstName": "James",
"lastName": "Smith",
"email": "[email protected]"
},
"systemContact": {
"firstName": "Maria",
"lastName": "Williams",
"email": "[email protected]"
},
"licenseContact": {
"firstName": "Ava",
"lastName": "Brown",
"email": "[email protected]"
},
"eolDate": "2023-03-20",
"bolDate": "2022-03-21",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"contractNumber": 111111,
"region": "AMER",
"term": 12,
"graceTerm": 1,
"currency": "USD",
"contractId": 1111,
"discount": 20,
"spf": "SPF123",
"vmwarePurchaseOrder": "PO-100000",
"billingOrderPreference": "ONLINE",
"billToAccount": {
"accountNumber": 10001,
"location": "location-100010"
},
"entitlementAccount": 111111,
"sellingPricePerPoint": 0.88,
"fillPurchaseOrderInMBO": "boolean"
}
],
"total": 1
}
total
{
"content": [
{
"id": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
"code": "VSPP3-1800-C",
"bolDate": "2010-10",
"eolDate": "2030-10",
"contractType": "PAY-GO",
"minCommit": 1800,
"term": 12,
"discount": "number",
"commitType": "MONTHLY",
"commitValue": "integer"
}
],
"total": 1
}
total
{
"content": [
{
"contract": {
"contractNumber": 111111,
"contractReferenceNumber": "AMER1111RENTAL",
"currency": "USD"
},
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
},
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca2",
"dealNumber": 20001,
"productSKU": "VMW-VSANV2-STD-C",
"productCategory": "Cloud Infrastructure and Management",
"projectedDealValue": 10000,
"status": "CLOSED_WON",
"extendStatus": "NOT_EXTENDED",
"creationDate": "2022-08-03",
"expirationDate": "2023-01-30",
"expectedCloseDate": "2022-10-23",
"closeDate": "2022-11-01",
"fiscalQuarter": "Q3FY2022",
"serviceProviderContact": "[email protected]",
"aggregatorSalesContactLead": "[email protected]",
"aggregatorManager": "[email protected]",
"promotionEvent": "SALES_CAMPAIGN"
}
],
"total": 1
}
total
{
"content": [
{
"productSKU": "VSPP3-1800-C",
"productDisplayName": "VMware Virtual SAN Standard",
"geo": "USC",
"startDate": "2022-10-29",
"endDate": "2023-01-30"
}
],
"total": 1
}
total
{
"content": [
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
],
"total": 1
}
total
{
"content": [
{
"id": "33f574a8-xxxx-xxxx-xxxx-b10700000008",
"name": "Sp Corp",
"prmId": 1111111,
"status": "ACTIVE"
}
],
"total": 1
}
total
{
"content": [
{
"id": "f6bc69ec-xxxx-xxxx-xxxx-eeafc4a7e0bb",
"contract": {
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"currency": "USD"
},
"usagePeriod": "2022-06",
"autoReportType": "AUTOMATED",
"serviceProviderPurchaseOrder": "VMW202206",
"vmwarePurchaseOrder": "PO-100000",
"billingOrderPreference": "ONLINE",
"status": "CLOSED",
"orderNumber": 1111111,
"summary": {
"minimumCommit": 1800,
"reported": "number",
"overage": "number",
"underage": 1800,
"total": 1800,
"listPrice": "number",
"sellingPrice": "number",
"discount": "number"
},
"closedTime": "2022-07-02T00:00:00Z"
}
],
"total": 1
}
total
{
"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": "boolean",
"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",
"cspOrgId": "Invalid for Rental"
}
}
],
"total": 1
}
total
{
"content": [
{
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
},
"id": "6a2ac963-xxxx-xxxx-xxxx-64151fe188f9",
"instanceId": "de16af2a-xxxx-xxxx-xxxx-8cd5d5bdad1e",
"name": "my_um",
"version": "4.0.0.0",
"mode": "PRODUCTION",
"connectionMode": "ONLINE",
"lastUploadTime": "2022-05-06T00:00:00Z",
"uploadHealthStatus": "GREEN",
"lastModifiedTime": "2022-05-06T00:00:00Z"
}
],
"total": 1
}
total
{
"content": [
{
"id": "04101966-xxxx-xxxx-xxxx-b21ff240d3f6",
"name": "my_site",
"countryRegion": "US",
"address": "1 S Main St, San Francisco",
"postCode": 94105,
"lastModifiedTime": "2022-05-06T00:00:00Z"
}
],
"total": 1
}
total
{
"content": [
{
"id": "8dec8aaa-xxxx-xxxx-xxxx-760aa839aeb3",
"firstName": "James",
"lastName": "Smith",
"email": "[email protected]",
"status": "ACTIVE",
"roles": [
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
]
}
],
"total": 1
}
total
{
"name": "test",
"prmId": 1111111
}
name
prmId
{
"code": "VSPP3-PREPAY-C",
"contractType": "PRE-PAY",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
}
code
contractType
{
"tieredPriceDetails": [
{
"unitRange": "0-100",
"ppu": 3,
"quantity": 100,
"split": 0.5,
"points": 150
}
]
}
{
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
name
code
type
{
"productSKU": "VSPP3-1800-C",
"productDisplayName": "VMware Virtual SAN Standard",
"geo": "USC",
"startDate": "2022-10-29",
"endDate": "2023-01-30"
}
productSKU
productDisplayName
geo
Effective start date
Effective end date
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
id
name
Request to send back a monthly billing order
{
"comment": "sent back by [email protected]"
}
comment
{
"name": "Sp Corp",
"prmId": 1111111
}
name
prmId
firstName
lastName
{
"id": "33f574a8-xxxx-xxxx-xxxx-b10700000008",
"name": "Sp Corp",
"prmId": 1111111,
"status": "ACTIVE"
}
id
name
prmId
status
{
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
}
name
prmId
countryRegion
{
"id": "f6bc69ec-xxxx-xxxx-xxxx-eeafc4a7e0bb",
"contract": {
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"currency": "USD"
},
"usagePeriod": "2022-06",
"autoReportType": "AUTOMATED",
"serviceProviderPurchaseOrder": "VMW202206",
"vmwarePurchaseOrder": "PO-100000",
"billingOrderPreference": "ONLINE",
"status": "CLOSED",
"orderNumber": 1111111,
"summary": {
"minimumCommit": 1800,
"reported": "number",
"overage": "number",
"underage": 1800,
"total": 1800,
"listPrice": "number",
"sellingPrice": "number",
"discount": "number"
},
"closedTime": "2022-07-02T00:00:00Z"
}
id
usagePeriod
autoReportType
Purchase order from cloud services provider of the billing order
Purchase order with VMware
Billing order preference
Current billing order status
orderNumber
Valid when a monthly billing order is closed
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"currency": "USD"
}
id
status
contractReferenceNumber
currency
{
"minimumCommit": 1800,
"reported": "number",
"overage": "number",
"underage": 1800,
"total": 1800,
"listPrice": "number",
"sellingPrice": "number",
"discount": "number"
}
Minimum commitment
Reported usages
Overage usage which exceeds the minimum commitment
Underage usage which is added to cover the minimum commitment
Total usages
Total list price
Total selling price
Final discount
firstName
lastName
{
"unitRange": "0-100",
"ppu": 3,
"quantity": 100,
"split": 0.5,
"points": 150
}
Unit range for tiered price
Points per unit in the unit range
Quantity in the unit range
Units split out of the total report units using this tiered price.
Points in the unit range.
{
"tokenType": "bearer",
"accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJTRVNTSU9OIiwiY29udGV4dCI6IjE2MDAxYmY1LTRiYmUtNGE3YS1hMTJkLTE3OWM1Njk0YmI4YyIsImlhdCI6MTY4MjM5Mzg5NCwiZXhwIjoxNjgyMzk1Njk0fQ.Yw5Ys7t7whl28ptPXn4AouK2cIOR4fx6Cg_KOmdUBZDZD83UaifCRHbnpJrqgyNUSw7eHgjVFG_31aAOI9gvBw",
"expiresIn": 1800
}
Access token type. Currently it is always bearer.
Access token in jwt token format, which will be used for subsequent resource API calls. Authorization: Bearer {accessToken}
.
The seconds token will expire in.
{
"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": "boolean",
"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",
"cspOrgId": "Invalid for Rental"
}
}
id
Product SKU code
Product category
Product name
Usage site id
Usage site name
End customer number
End customer name
Reported quantity
Points per unit
Total points
Unit of measure
Unit price
List price
Final discount
Selling price
{
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
},
"id": "6a2ac963-xxxx-xxxx-xxxx-64151fe188f9",
"instanceId": "de16af2a-xxxx-xxxx-xxxx-8cd5d5bdad1e",
"name": "my_um",
"version": "4.0.0.0",
"mode": "PRODUCTION",
"connectionMode": "ONLINE",
"lastUploadTime": "2022-05-06T00:00:00Z",
"uploadHealthStatus": "GREEN",
"lastModifiedTime": "2022-05-06T00:00:00Z"
}
id
Instance UUID
name
version
mode
connectionMode
lastUploadTime
uploadHealthStatus
lastModifiedTime
{
"id": "04101966-xxxx-xxxx-xxxx-b21ff240d3f6",
"name": "my_site",
"countryRegion": "US",
"address": "1 S Main St, San Francisco",
"postCode": 94105,
"lastModifiedTime": "2022-05-06T00:00:00Z"
}
id
name
countryRegion
address
postCode
lastModifiedTime
{
"id": "8dec8aaa-xxxx-xxxx-xxxx-760aa839aeb3",
"firstName": "James",
"lastName": "Smith",
"email": "[email protected]",
"status": "ACTIVE",
"roles": [
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
]
}
id
firstName
lastName
status
{
"type": "string",
"userToken": "e6IsZmpOjEJ4g-bazyo5gl9Y"
}