Terminate Contract Using POST
Terminate a contract identified by the contract id.
Pre-authorized roles: Operations
Request
URI
POST
https://{api_host}//vcp.vmware.com/api/aggregator/v1/contracts/{contractId}/terminate
COPY
Path Parameters
string
contractId
Required
Contract id
contractId example
630c2f68-xxxx-xxxx-xxxx-61f8245eaca1
Request Body
Request to terminate a contract
AggContractTerminateRequest
of type(s)
application/json
Required
{
"effectiveDate": "2023-03-01",
"comment": "terminated by [email protected]",
"reason": "Service Provider Bankruptcy"
}
string As date
As date
effectiveDate
Required
Terminate date
string
comment
Required
comment
string
reason
Required
Service Provider Bankruptcy,Aggregator Swap,Service Provider Delinquent,COVID Impact,Partner Connect Fee,Competitor Offering,Merger and Acquisition
Responses
200
OK
Returns
ContractTerminateBriefRequestDTO
of type(s)
application/json
{
"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"
}
string
id
Optional
Contract terminate 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
Possible values are :
CREATE,
UPGRADE,
DOWNGRADE,
TERMINATE,
RENEW,
TOPUP,
AMEND,
PREPAY_AMEND,
THRESHOLD_UPDATE,
BASIC_INFO_UPDATE,
string As date
As date
effectiveDate
Optional
effectiveDate
string As date-time
As date-time
createdTime
Optional
createdTime
string
token
Optional
token
400
Bad Request
Operation doesn't return any data structure
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
Contract Operations
POST
Create Contract Using POST
POST
Downgrade Contract Using POST
GET
Get Contract Using GET
GET
List Contracts Using GET
GET
List Usage Sites By Contract Id Using GET
POST
Terminate Contract Using POST
POST
Topup Using POST
PATCH
Update Using PATCH
POST
Upgrade Contract Using POST