Topup Using POST | Cloud Provider Commerce Portal

Topup Using POST

Top up a PRE-PAY contract identified by the contract id.

Pre-authorized roles: Operations

Request

URI

POST

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

COPY

Path Parameters

string

contractId

Required

Contract id

contractId example

630c2f68-xxxx-xxxx-xxxx-61f8245eaca1

Request Body

Request to top up a contract

AggContractTopupRequest of type(s) application/json

Required

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

number

prepayment

Required

Top-Up Amount

integer As int32 As int32

term

Required

Term (in Months), must be greater than or equal to the contract term

array of number

burnDownSchedule

Required

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].

string

comment

Optional

comment

string

vmwarePurchaseOrder

Required

Purchase Order with VMware

Responses

200

Returns ContractTopUpBriefRequestDTO of type(s) application/json

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

string

Optional

Contract top up 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

Current request type