VMware Cloud Provider Commerce Portal - Cloud Services Provider API Documentation Data Structures
Aggregator
JSON Example
{
"name": "Agg Corp",
"prmId": 2222222
}string
name
Optional
name
string
prmId
Optional
prmId
AggregatorContact
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
email
Optional
AllCustomer
JSON Example
{
"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
}string
customerId
Optional
End User ID
string
name
Optional
name
string
address1
Optional
address1
string
address2
Optional
address2
string
countryRegion
Optional
countryRegion
string
city
Optional
city
string
state
Optional
state
string
postalCode
Optional
postalCode
BaseAuthRequest
JSON Example
{
"type": "UserToken"
}string
type
Optional
type
BillingOrderCommentDTO
JSON Example
{
"user": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"createdTime": "2023-03-01T08:14:56Z",
"content": "approved by [email protected]"
}string As date-time As date-time
createdTime
Optional
createdTime
string
content
Optional
content
BriefCustomer
JSON Example
{
"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
}string
id
Optional
id
string
customerNumber
Optional
End User ID
string
name
Optional
name
string
address1
Optional
address1
string
address2
Optional
address2
string
countryRegion
Optional
countryRegion
string
city
Optional
city
string
state
Optional
state
string
postalCode
Optional
Zip/Postal Code
BriefProduct
JSON Example
{
"id": "892ae1d0-xxxx-xxxx-xxxx-f04b00000005",
"code": "VR-OSTACK4-C",
"name": "VMware Integrated OpenStack"
}string
id
Optional
id
string
code
Optional
code
string
name
Optional
name
ClusterUsage
JSON Example
{
"clusterId": "cluster-test",
"quantity": 1
}string
clusterId
Optional
Cluster id of the cluster usage
number
quantity
Optional
Quantity of the cluster usage
CommentRequest
Request to add a comment to a monthly billing order
JSON Example
{
"comment": "updated by [email protected]"
}string
comment
Required
comment
Commitment
JSON Example
{
"beginMonth": "2025-01",
"endMonth": "2025-12",
"quantity": 100
}string
beginMonth
Optional
Begin month of a certain time period
string
endMonth
Optional
End month of a certain time period
number
quantity
Optional
Quantity of a certain time period
CompactCustomer
JSON Example
{
"id": "c7240730-xxxx-xxxx-xxxx-70be00000001",
"customerNumber": 1000000001,
"name": "Steven"
}string
id
Optional
id
string
customerNumber
Optional
End User ID
string
name
Optional
name
CompactCustomerCommitment
JSON Example
{
"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"
}string
id
Optional
id
string
bol
Optional
start month
string
eol
Optional
end month
number
commitment
Optional
commitment points
string
status
Optional
status
object
minCommits
Optional
minimum monthly commitment
string
name
Optional
name
Contract
JSON Example
{
"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"
}string
id
Optional
id
string As date As date
eolDate
Optional
End date of the contract
string As date As date
bolDate
Optional
Begin date of the contract
string
status
Optional
status
string
contractReferenceNumber
Optional
contractReferenceNumber
string
contractNumber
Optional
contractNumber
string
region
Optional
Region of the cloud services provider
integer As int32 As int32
term
Optional
Term of the contract(in months)
integer As int32 As int32
graceTerm
Optional
Grace term(in months) when it's a PAY-GO contract
string
currency
Optional
currency
ContractCustomerBriefRequest
JSON Example
{
"name": "Steven",
"address1": "SW Ste 212 Manhattan DC",
"address2": "1250 Canal Street Ave SW",
"countryRegion": "US",
"city": "New York",
"state": "NY",
"postalCode": 10041
}string
name
Required
name
string
address1
Required
address1
string
address2
Optional
address2
string
countryRegion
Required
countryRegion
string
city
Optional
city
string
state
Optional
State is required when country/region is US
string
postalCode
Required
Zip/Postal Code
ContractCustomerSisoUpdateRequest
JSON Example
{
"reseller": "Multi-Cloud Provider - 100393",
"influencer": "Mega Clouds - 110256",
"msp": "Managed Cloud Service - 13990"
}string
reseller
Optional
Reseller SISO
string
influencer
Optional
Influencer SISO
string
msp
Optional
MSP SISO
ContractSKU
JSON Example
{
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
}string
code
Optional
code
string
contractType
Optional
contractType
Customer
JSON Example
{
"id": "c7240730-xxxx-xxxx-xxxx-250300000003",
"customerNumber": 1000000001,
"name": "Steven"
}string
id
Optional
id
string
customerNumber
Optional
customerNumber
string
name
Optional
name
CustomerCommitmentCreateRequest
Request to create a customer commitment
JSON Example
{
"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"
}string
customerId
Required
customerId
number
commitment
Required
commitment points during bol and eol
string
bol
Required
start month
string
eol
Required
end month
object
minCommits
Required
minimum monthly commitment. Start with bol, end with eol
string
name
Required
commitment name, for your reference only
CustomerCommitmentUpdateRequest
JSON Example
{
"name": "my_commitment2"
}string
name
Required
name
InlineUserToken1
This data structure has no properties.
string
type
Optional
type
string
userToken
Optional
userToken
InlineUserToken1
This data structure has no properties.
string
type
Optional
type
string
userToken
Optional
userToken
LicenseContact
Valid for RENTAL and SOV
JSON Example
{
"firstName": "Ava",
"lastName": "Brown",
"email": "[email protected]"
}string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
email
Optional
Metadata
JSON Example
{
"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"
}boolean
inMinCommit
Optional
Flag to indicate whether it will be counted in minimum commitment
number
minQuantity
Optional
Minimum quantity of usage if the product's usage is reported
string
comment
Optional
Comment to explain why usage is manually changed
boolean
readOnly
Optional
readOnly
string
subscriptionId
Optional
Subscription id
string
proformaNumber
Optional
Proforma number
string
invoiceNumber
Optional
Invoice number
string
sid
Optional
Order sid
string
orderNumber
Optional
Order number
PageOfAllCustomer
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PageOfBillingOrderCommentDTO
JSON Example
{
"content": [
{
"user": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"createdTime": "2023-03-01T08:14:56Z",
"content": "approved by [email protected]"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfBriefCustomer
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PageOfCompactCustomerCommitment
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PageOfContract
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PageOfProduct
JSON Example
{
"content": [
{
"product": {
"id": "892ae1d0-xxxx-xxxx-xxxx-f04b00000005",
"code": "VR-OSTACK4-C",
"name": "VMware Integrated OpenStack"
},
"uom": "GB vRAM"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfProductCommitment
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PageOfProductFamilySimple
JSON Example
{
"content": [
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"name": "Rental Commercial",
"code": "RENTAL"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfRole
JSON Example
{
"content": [
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfSimpleBillingOrder
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PageOfUsage
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PageOfUsageMeter
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PageOfUsageSite
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PageOfUsageSiteSimple
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PageOfUser
JSON Example
{
"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
}integer As int64 As int64
total
Optional
total
PartnerProfile
JSON Example
{
"name": "test",
"prmId": 1111111
}string
name
Optional
name
string
prmId
Optional
prmId
PriceDetail
JSON Example
{
"tieredPriceDetails": [
{
"unitRange": "0-100",
"ppu": 3,
"quantity": 100,
"split": 0.5,
"points": 150
}
]
}
Product
JSON Example
{
"product": {
"id": "892ae1d0-xxxx-xxxx-xxxx-f04b00000005",
"code": "VR-OSTACK4-C",
"name": "VMware Integrated OpenStack"
},
"uom": "GB vRAM"
}string
uom
Optional
uom
ProductCommitment
JSON Example
{
"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"
}string
id
Optional
id
string
name
Optional
Commitment name
string
bol
Optional
Begin month of the commitment
string
eol
Optional
End month of the commitment
string
uom
Optional
uom
string
payment
Optional
payment
string
status
Optional
status
string
term
Optional
term
ProductCommitmentCreateRequest
JSON Example
{
"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"
}string
customerId
Required
customerId
string
product
Required
product
string
uom
Required
uom
number
quantity
Required
Quantity of every month
string
bol
Required
Begin month of the commitment
string
term
Required
term
string
name
Required
name
string
payment
Required
payment
ProductCommitmentRenewRequest
JSON Example
{
"name": "my_commitment_2"
}string
name
Optional
commitment name, for your reference only
ProductCommitmentUpdateRequest
JSON Example
{
"name": "my_commitment_2"
}string
name
Required
commitment name, for your reference only
ProductFamily
JSON Example
{
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}string
name
Optional
name
string
code
Optional
code
string
type
Optional
type
ProductFamilySimple
JSON Example
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"name": "Rental Commercial",
"code": "RENTAL"
}string
id
Optional
id
string
name
Optional
name
string
code
Optional
code
Role
JSON Example
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}string
id
Optional
id
string
name
Optional
name
ServiceProviderContact
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
email
Optional
SimpleBillingOrder
JSON Example
{
"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"
}string
id
Optional
id
string
usagePeriod
Optional
usagePeriod
string
autoReportType
Optional
autoReportType
string
serviceProviderPurchaseOrder
Optional
Purchase order from cloud services provider of the billing order
string
status
Optional
Current billing order status
string
orderNumber
Optional
orderNumber
string As date-time As date-time
closedTime
Optional
Valid when a monthly billing order is closed
SimpleContract
JSON Example
{
"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"
}string
id
Optional
id
string
status
Optional
status
string
contractReferenceNumber
Optional
contractReferenceNumber
string
currency
Optional
currency
SimpleUsageSite
JSON Example
{
"id": "04101966-xxxx-xxxx-xxxx-b21ff240d3f6",
"name": "my_site"
}string
id
Optional
id
string
name
Optional
name
SisoInfo
JSON Example
{
"reseller": "Multi-Cloud Provider - 100393",
"influencer": "Mega Clouds - 110256",
"msp": "Managed Cloud Service - 13990"
}string
reseller
Optional
Reseller SISO
string
influencer
Optional
Influencer SISO
string
msp
Optional
MSP SISO
SubmitRequest
Request to submit a monthly billing order
JSON Example
{
"serviceProviderPurchaseOrder": "VMW202206"
}string
serviceProviderPurchaseOrder
Required
Purchase order from cloud services provider of the billing order
Summary
JSON Example
{
"minimumCommit": 1800,
"reported": "number",
"overage": "number",
"underage": 1800,
"total": 1800,
"listPrice": "number",
"sellingPrice": "number",
"discount": "number"
}number
minimumCommit
Optional
Minimum commitment
number
reported
Optional
Reported usages
number
overage
Optional
Overage usage which exceeds the minimum commitment
number
underage
Optional
Underage usage which is added to cover the minimum commitment
number
total
Optional
Total usages
number
listPrice
Optional
Total list price
number
sellingPrice
Optional
Total selling price
number
discount
Optional
Final discount
SystemContact
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
email
Optional
TieredPrice
JSON Example
{
"unitRange": "0-100",
"ppu": 3,
"quantity": 100,
"split": 0.5,
"points": 150
}string
unitRange
Optional
Unit range for tiered price
number
ppu
Optional
Points per unit in the unit range
number
quantity
Optional
Quantity in the unit range
number
split
Optional
Units split out of the total report units using this tiered price.
number
points
Optional
Points in the unit range.
Token
JSON Example
{
"tokenType": "bearer",
"accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJTRVNTSU9OIiwiY29udGV4dCI6IjE2MDAxYmY1LTRiYmUtNGE3YS1hMTJkLTE3OWM1Njk0YmI4YyIsImlhdCI6MTY4MjM5Mzg5NCwiZXhwIjoxNjgyMzk1Njk0fQ.Yw5Ys7t7whl28ptPXn4AouK2cIOR4fx6Cg_KOmdUBZDZD83UaifCRHbnpJrqgyNUSw7eHgjVFG_31aAOI9gvBw",
"expiresIn": 1800
}string
tokenType
Optional
Access token type. Currently it is always bearer.
string
accessToken
Optional
Access token in jwt token format, which will be used for subsequent resource API calls. Authorization: Bearer {accessToken}.
integer As int64 As int64
expiresIn
Optional
The seconds token will expire in.
Usage
JSON Example
{
"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"
}
}string
id
Optional
id
string
code
Optional
Product SKU code
string
category
Optional
Product category
string
name
Optional
Product name
string
siteId
Optional
Usage site id
string
siteName
Optional
Usage site name
string
customerNumber
Optional
End customer number
string
customerName
Optional
End customer name
number
quantity
Optional
Reported quantity
number
ppu
Optional
Points per unit
number
points
Optional
Total points
string
uom
Optional
Unit of measure
number
unitPrice
Optional
Unit price
number
listPrice
Optional
List price
number
discount
Optional
Final discount
number
sellingPrice
Optional
Selling price
UsageMeter
JSON Example
{
"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"
}string
id
Optional
id
string
instanceId
Optional
Instance UUID
string
name
Optional
name
string
version
Optional
version
string
mode
Optional
mode
string
connectionMode
Optional
connectionMode
string As date-time As date-time
lastUploadTime
Optional
lastUploadTime
string
uploadHealthStatus
Optional
uploadHealthStatus
string As date-time As date-time
lastModifiedTime
Optional
lastModifiedTime
UsageSite
JSON Example
{
"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"
}string
id
Optional
id
string
name
Optional
name
string
countryRegion
Optional
countryRegion
string
address
Optional
address
string
postCode
Optional
postCode
string As date-time As date-time
lastModifiedTime
Optional
lastModifiedTime
UsageSiteSimple
JSON Example
{
"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"
}string
id
Optional
id
string
name
Optional
name
string
countryRegion
Optional
countryRegion
string
address
Optional
address
string
postCode
Optional
postCode
string As date-time As date-time
lastModifiedTime
Optional
lastModifiedTime
string
contractReferenceNumber
Optional
contractReferenceNumber
User
JSON Example
{
"id": "8dec8aaa-xxxx-xxxx-xxxx-760aa839aeb3",
"firstName": "James",
"lastName": "Smith",
"email": "[email protected]",
"status": "ACTIVE",
"roles": [
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
]
}string
id
Optional
id
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
email
Optional
string
status
Optional
status
UserToken
AllOf
JSON Example
{
"type": "string",
"userToken": "e6IsZmpOjEJ4g-bazyo5gl9Y"
}Node: apidepo-liferay-dxp-v1-be-w-0:8080: