VMware Cloud Provider Commerce Portal - Cloud Services Provider API Documentation Data Structures
{
"name": "Agg Corp",
"prmId": 2222222
}
name
prmId
firstName
lastName
{
"customerId": "0102329233",
"name": "xxx Company",
"address1": "1 S Main St, San Francisco",
"address2": "1 S Main St, San Francisco",
"countryRegion": "US",
"city": "New York",
"state": "California",
"postalCode": 94105
}
End User ID
name
address1
address2
countryRegion
city
state
postalCode
{
"type": "UserToken"
}
type
{
"user": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"createdTime": "2023-03-01T08:14:56Z",
"content": "approved by [email protected]"
}
createdTime
content
{
"id": "c7240730-xxxx-xxxx-xxxx-250300000003",
"customerNumber": 1000000001,
"name": "Steven",
"address1": "SW Ste 212 Manhattan DC",
"address2": "1250 Canal Street Ave SW",
"countryRegion": "US",
"city": "New York",
"state": "NY",
"postalCode": 10041
}
id
End User ID
name
address1
address2
countryRegion
city
state
Zip/Postal Code
{
"id": "892ae1d0-xxxx-xxxx-xxxx-f04b00000005",
"code": "VR-OSTACK4-C",
"name": "VMware Integrated OpenStack"
}
id
code
name
{
"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": "updated by [email protected]"
}
comment
{
"beginMonth": "2025-01",
"endMonth": "2025-12",
"quantity": 100
}
Begin month of a certain time period
End month of a certain time period
Quantity of a certain time period
{
"id": "c7240730-xxxx-xxxx-xxxx-70be00000001",
"customerNumber": 1000000001,
"name": "Steven"
}
id
End User ID
name
{
"id": "1928cac2-xxxx-xxxx-xxxx-045625c0db08",
"customer": {
"id": "c7240730-xxxx-xxxx-xxxx-70be00000001",
"customerNumber": 1000000001,
"name": "Steven"
},
"bol": "2023-06",
"eol": "2024-05",
"commitment": 120,
"status": "ACTIVE",
"minCommits": {
"2023-06": 10,
"2023-07": 10,
"2023-08": 10,
"2023-09": 10,
"2023-10": 10,
"2023-11": 10,
"2023-12": 10,
"2024-01": 10,
"2024-02": 10,
"2024-03": 10,
"2024-04": 10,
"2024-05": 10
},
"name": "my_commitment"
}
id
start month
end month
commitment points
status
minimum monthly commitment
name
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"aggregator": {
"name": "Agg Corp",
"prmId": 2222222
},
"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"
}
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
{
"name": "Steven",
"address1": "SW Ste 212 Manhattan DC",
"address2": "1250 Canal Street Ave SW",
"countryRegion": "US",
"city": "New York",
"state": "NY",
"postalCode": 10041
}
name
address1
address2
countryRegion
city
State is required when country/region is US
Zip/Postal Code
{
"reseller": "Multi-Cloud Provider - 100393",
"influencer": "Mega Clouds - 110256",
"msp": "Managed Cloud Service - 13990"
}
Reseller SISO
Influencer SISO
MSP SISO
{
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
}
code
contractType
{
"id": "c7240730-xxxx-xxxx-xxxx-250300000003",
"customerNumber": 1000000001,
"name": "Steven"
}
id
customerNumber
name
Request to create a customer commitment
{
"customerId": "c7240730-xxxx-xxxx-xxxx-70be00000001",
"commitment": 120,
"bol": "2023-06",
"eol": "2024-05",
"minCommits": {
"2023-06": 10,
"2023-07": 10,
"2023-08": 10,
"2023-09": 10,
"2023-10": 10,
"2023-11": 10,
"2023-12": 10,
"2024-01": 10,
"2024-02": 10,
"2024-03": 10,
"2024-04": 10,
"2024-05": 10
},
"name": "my_commitment"
}
customerId
commitment points during bol and eol
start month
end month
minimum monthly commitment. Start with bol, end with eol
commitment name, for your reference only
{
"name": "my_commitment2"
}
name
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"
}
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
{
"content": [
{
"customerId": "0102329233",
"name": "xxx Company",
"address1": "1 S Main St, San Francisco",
"address2": "1 S Main St, San Francisco",
"countryRegion": "US",
"city": "New York",
"state": "California",
"postalCode": 94105
}
],
"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": "c7240730-xxxx-xxxx-xxxx-250300000003",
"customerNumber": 1000000001,
"name": "Steven",
"address1": "SW Ste 212 Manhattan DC",
"address2": "1250 Canal Street Ave SW",
"countryRegion": "US",
"city": "New York",
"state": "NY",
"postalCode": 10041
}
],
"total": 1
}
total
{
"content": [
{
"id": "1928cac2-xxxx-xxxx-xxxx-045625c0db08",
"customer": {
"id": "c7240730-xxxx-xxxx-xxxx-70be00000001",
"customerNumber": 1000000001,
"name": "Steven"
},
"bol": "2023-06",
"eol": "2024-05",
"commitment": 120,
"status": "ACTIVE",
"minCommits": {
"2023-06": 10,
"2023-07": 10,
"2023-08": 10,
"2023-09": 10,
"2023-10": 10,
"2023-11": 10,
"2023-12": 10,
"2024-01": 10,
"2024-02": 10,
"2024-03": 10,
"2024-04": 10,
"2024-05": 10
},
"name": "my_commitment"
}
],
"total": 1
}
total
{
"content": [
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"aggregator": {
"name": "Agg Corp",
"prmId": 2222222
},
"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"
}
],
"total": 1
}
total
{
"content": [
{
"product": {
"id": "892ae1d0-xxxx-xxxx-xxxx-f04b00000005",
"code": "VR-OSTACK4-C",
"name": "VMware Integrated OpenStack"
},
"uom": "GB vRAM"
}
],
"total": 1
}
total
{
"content": [
{
"id": "775dc4c1-xxxx-xxxx-xxxx-8328ac75e878",
"name": "my_commitment_1",
"bol": "2025-01",
"eol": "2025-12",
"commitment": [
{
"beginMonth": "2025-01",
"endMonth": "2025-12",
"quantity": 100
}
],
"product": {
"id": "892ae1d0-xxxx-xxxx-xxxx-f04b00000005",
"code": "VR-OSTACK4-C",
"name": "VMware Integrated OpenStack"
},
"uom": "GB vRAM",
"customer": {
"id": "c7240730-xxxx-xxxx-xxxx-250300000003",
"customerNumber": 1000000001,
"name": "Steven"
},
"payment": "MONTHLY",
"status": "ACTIVE",
"term": "YEAR_1"
}
],
"total": 1
}
total
{
"content": [
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"name": "Rental Commercial",
"code": "RENTAL"
}
],
"total": 1
}
total
{
"content": [
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
],
"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",
"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"
}
}
],
"total": 1
}
total
{
"content": [
{
"id": "6a2ac963-xxxx-xxxx-xxxx-64151fe188f9",
"instanceId": "de16af2a-xxxx-xxxx-xxxx-8cd5d5bdad1e",
"name": "my_um",
"version": "4.0.0.0",
"mode": "PRODUCTION",
"usageSite": {
"id": "04101966-xxxx-xxxx-xxxx-b21ff240d3f6",
"name": "my_site"
},
"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": "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",
"contractReferenceNumber": "AMER1111RENTAL"
}
],
"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
{
"tieredPriceDetails": [
{
"unitRange": "0-100",
"ppu": 3,
"quantity": 100,
"split": 0.5,
"points": 150
}
]
}
{
"product": {
"id": "892ae1d0-xxxx-xxxx-xxxx-f04b00000005",
"code": "VR-OSTACK4-C",
"name": "VMware Integrated OpenStack"
},
"uom": "GB vRAM"
}
uom
{
"id": "775dc4c1-xxxx-xxxx-xxxx-8328ac75e878",
"name": "my_commitment_1",
"bol": "2025-01",
"eol": "2025-12",
"commitment": [
{
"beginMonth": "2025-01",
"endMonth": "2025-12",
"quantity": 100
}
],
"product": {
"id": "892ae1d0-xxxx-xxxx-xxxx-f04b00000005",
"code": "VR-OSTACK4-C",
"name": "VMware Integrated OpenStack"
},
"uom": "GB vRAM",
"customer": {
"id": "c7240730-xxxx-xxxx-xxxx-250300000003",
"customerNumber": 1000000001,
"name": "Steven"
},
"payment": "MONTHLY",
"status": "ACTIVE",
"term": "YEAR_1"
}
id
Commitment name
Begin month of the commitment
End month of the commitment
uom
payment
status
term
{
"customerId": "c7240730-xxxx-xxxx-xxxx-250300000003",
"product": "VR-OSTACK4-C",
"uom": "GB vRAM",
"quantity": 100,
"bol": "2025-01",
"term": "YEAR_1",
"name": "my_commitment_1",
"payment": "MONTHLY"
}
customerId
product
uom
Quantity of every month
Begin month of the commitment
term
name
payment
{
"name": "my_commitment_2"
}
commitment name, for your reference only
{
"name": "my_commitment_2"
}
commitment name, for your reference only
{
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
name
code
type
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"name": "Rental Commercial",
"code": "RENTAL"
}
id
name
code
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
id
name
firstName
lastName
{
"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",
"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
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
{
"id": "04101966-xxxx-xxxx-xxxx-b21ff240d3f6",
"name": "my_site"
}
id
name
{
"reseller": "Multi-Cloud Provider - 100393",
"influencer": "Mega Clouds - 110256",
"msp": "Managed Cloud Service - 13990"
}
Reseller SISO
Influencer SISO
MSP SISO
Request to submit a monthly billing order
{
"serviceProviderPurchaseOrder": "VMW202206"
}
Purchase order from cloud services provider of the billing order
{
"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"
}
}
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
{
"id": "6a2ac963-xxxx-xxxx-xxxx-64151fe188f9",
"instanceId": "de16af2a-xxxx-xxxx-xxxx-8cd5d5bdad1e",
"name": "my_um",
"version": "4.0.0.0",
"mode": "PRODUCTION",
"usageSite": {
"id": "04101966-xxxx-xxxx-xxxx-b21ff240d3f6",
"name": "my_site"
},
"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": "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",
"contractReferenceNumber": "AMER1111RENTAL"
}
id
name
countryRegion
address
postCode
lastModifiedTime
contractReferenceNumber
{
"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"
}