Create Customer Commit Using POST
Create a SOV contract customer commitment. Pre-authorized roles: Operations
Request
URI
POST
https://{api_host}//vcp.vmware.com/api/provider/v1/contracts/{contractId}/customerCommitments
COPY
Path Parameters
string
contractId
Required
Contract id
contractId example
630c2f68-xxxx-xxxx-xxxx-61f8245eaca1
Request Body
Request to create a customer commitment
CustomerCommitmentCreateRequest of type(s) application/json
Required
{
"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
Responses
200
OK
Returns CompactCustomerCommitment of type(s) application/json
{
"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
Possible values are : ACTIVE, COMPLETED, CANCELLED, PENDING_EFFECTIVE_PERIOD,
object
minCommits
Optional
minimum monthly commitment
string
name
Optional
name
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