Upgrade Contract Using POST

Upgrade a contract identified by the contract id to a PAY-GO contract.

Pre-authorized roles: Operations

Request

URI

POST

https://{api_host}//vcp.vmware.com/api/aggregator/v1/contracts/{contractId}/upgrade

COPY

Path Parameters

string

contractId

Required

Contract id

contractId example

630c2f68-xxxx-xxxx-xxxx-61f8245eaca1

Request Body

Request to upgrade a contract

AggContractUpgradeRequest of type(s) application/json

Required

{
    "contractSKUId": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
    "effectiveDate": "2023-03-01",
    "comment": "Higher Monthly Commit"
}

string

contractSKUId

Required

New contract SKU

string As date As date

effectiveDate

Required

effectiveDate

string

comment

Optional

comment

Responses

200

Returns ContractUpgradeBriefRequestDTO of type(s) application/json

{
    "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"
}

string

Optional

Contract upgrade request id

string

status

Optional

Current status

Possible values are : PENDING_REVISE, PENDING_APPROVAL, PENDING_EFFECTIVE_DATE, PENDING_VENDOR, COMPLETED, REJECTED, WITHDRAWN, STOPPED,

string

requestType

Optional

requestType