Update Metering Policy Using PUT

Update Metering Policy Using PUT

Update the specified pricing policy

Request
URI
PUT
https://{api_host}/api/pricing
COPY
Request Body

The pricing policy identifier

pricing-policy of type(s) application/json
Required

Show optional properties

{
    "chargeModel": "string",
    "name": "string"
}
{
    "chargeModel": "string",
    "createdBy": "string",
    "description": "string",
    "id": "string",
    "lastUpdateTimestamp": 0,
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "meterings": [
        {
            "itemName": "string",
            "metering": {
                "baseRate": "number",
                "chargeBasedOn": "string",
                "chargeOnPowerState": "string",
                "chargePeriod": "string",
                "conditionalBaseRates": [
                    {
                        "baseRate": "number",
                        "usageLowerBound": "number"
                    }
                ],
                "fixedPrice": "number",
                "overage": false,
                "overageRate": "number",
                "unit": "string"
            }
        }
    ],
    "name": "string",
    "namedMeterings": [
        {
            "itemName": "string",
            "meterings": [
                {
                    "metering": {
                        "baseRate": "number",
                        "chargeBasedOn": "string",
                        "chargeOnPowerState": "string",
                        "chargePeriod": "string",
                        "conditionalBaseRates": [
                            {
                                "baseRate": "number",
                                "usageLowerBound": "number"
                            }
                        ],
                        "fixedPrice": "number",
                        "overage": false,
                        "overageRate": "number",
                        "unit": "string"
                    },
                    "name": "string"
                }
            ]
        }
    ],
    "oneTimeMeterings": [
        {
            "itemName": "string",
            "oneTimeMetering": {
                "oneTimeFixedPrice": "number"
            }
        }
    ],
    "tagBasedMeterings": [
        {
            "itemName": "string",
            "meterings": [
                {
                    "key": "string",
                    "metering": {
                        "baseRate": "number",
                        "chargeBasedOn": "string",
                        "chargeOnPowerState": "string",
                        "chargePeriod": "string",
                        "conditionalBaseRates": [
                            {
                                "baseRate": "number",
                                "usageLowerBound": "number"
                            }
                        ],
                        "fixedPrice": "number",
                        "overage": false,
                        "overageRate": "number",
                        "unit": "string"
                    },
                    "value": "string"
                }
            ]
        }
    ],
    "tagBasedOneTimeMeterings": [
        {
            "itemName": "string",
            "oneTimeMeterings": [
                {
                    "key": "string",
                    "oneTimeMetering": {
                        "oneTimeFixedPrice": "number"
                    },
                    "value": "string"
                }
            ]
        }
    ],
    "tagBasedPolicyRefs": [
        {
            "itemName": "string",
            "policyRefs": [
                {
                    "key": "string",
                    "policyRef": {
                        "policyId": "string",
                        "priority": 0
                    },
                    "value": "string"
                }
            ]
        }
    ],
    "tagBasedRateFactors": [
        {
            "itemName": "string",
            "rateFactors": [
                {
                    "key": "string",
                    "rateFactor": {
                        "contextMeteringItem": "string",
                        "rateFactor": "number"
                    },
                    "value": "string"
                }
            ]
        }
    ],
    "unconditionalMeterings": [
        {
            "itemName": "string",
            "unconditionalMetering": {
                "chargePeriod": "string",
                "rate": "number"
            }
        }
    ]
}
string
chargeModel
Required

The charge model of the pricing policy

Possible values are : ALLOCATION_POOL, RESERVATION_POOL, PAY_AS_YOU_GO, UNKNOWN,
string
createdBy
Optional

The policy creator

Possible values are : VRA, TA, TA_VCD, TA_VC, VROPS, UNKNOWN,
string
description
Optional

description

string As uuid As uuid
id
Optional

The UUID of the policy.
Note: It is required during update.

integer As int64 As int64
lastUpdateTimestamp
Optional

The last update timestamp of the policy

array of link
links
Optional

links

array of MeteringItem
meterings
Optional

Collection of metering items

string
name
Required

The pricing policy name

array of NamedMeteringItem
namedMeterings
Optional

Collection of named metering items

array of OneTimeMeteringItem
oneTimeMeterings
Optional

oneTimeMeterings

array of TagBasedMeteringItem
tagBasedMeterings
Optional

Collection of tag based metering items

array of TagBasedOneTimeMeteringItem
tagBasedOneTimeMeterings
Optional

tagBasedOneTimeMeterings

array of TagBasedPolicyRefItem
tagBasedPolicyRefs
Optional

tagBasedPolicyRefs

array of TagBasedRateFactorItem
tagBasedRateFactors
Optional

tagBasedRateFactors

array of UnconditionalMeteringItem
unconditionalMeterings
Optional

Collection of unconditional metering items

Authentication
This operation uses the following authentication methods.
Responses
200

The pricing policy was updated successfully in the system

Returns pricing-policy of type(s) application/json 
{
    "chargeModel": "string",
    "createdBy": "string",
    "description": "string",
    "id": "string",
    "lastUpdateTimestamp": 0,
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "meterings": [
        {
            "itemName": "string",
            "metering": {
                "baseRate": "number",
                "chargeBasedOn": "string",
                "chargeOnPowerState": "string",
                "chargePeriod": "string",
                "conditionalBaseRates": [
                    {
                        "baseRate": "number",
                        "usageLowerBound": "number"
                    }
                ],
                "fixedPrice": "number",
                "overage": false,
                "overageRate": "number",
                "unit": "string"
            }
        }
    ],
    "name": "string",
    "namedMeterings": [
        {
            "itemName": "string",
            "meterings": [
                {
                    "metering": {
                        "baseRate": "number",
                        "chargeBasedOn": "string",
                        "chargeOnPowerState": "string",
                        "chargePeriod": "string",
                        "conditionalBaseRates": [
                            {
                                "baseRate": "number",
                                "usageLowerBound": "number"
                            }
                        ],
                        "fixedPrice": "number",
                        "overage": false,
                        "overageRate": "number",
                        "unit": "string"
                    },
                    "name": "string"
                }
            ]
        }
    ],
    "oneTimeMeterings": [
        {
            "itemName": "string",
            "oneTimeMetering": {
                "oneTimeFixedPrice": "number"
            }
        }
    ],
    "tagBasedMeterings": [
        {
            "itemName": "string",
            "meterings": [
                {
                    "key": "string",
                    "metering": {
                        "baseRate": "number",
                        "chargeBasedOn": "string",
                        "chargeOnPowerState": "string",
                        "chargePeriod": "string",
                        "conditionalBaseRates": [
                            {
                                "baseRate": "number",
                                "usageLowerBound": "number"
                            }
                        ],
                        "fixedPrice": "number",
                        "overage": false,
                        "overageRate": "number",
                        "unit": "string"
                    },
                    "value": "string"
                }
            ]
        }
    ],
    "tagBasedOneTimeMeterings": [
        {
            "itemName": "string",
            "oneTimeMeterings": [
                {
                    "key": "string",
                    "oneTimeMetering": {
                        "oneTimeFixedPrice": "number"
                    },
                    "value": "string"
                }
            ]
        }
    ],
    "tagBasedPolicyRefs": [
        {
            "itemName": "string",
            "policyRefs": [
                {
                    "key": "string",
                    "policyRef": {
                        "policyId": "string",
                        "priority": 0
                    },
                    "value": "string"
                }
            ]
        }
    ],
    "tagBasedRateFactors": [
        {
            "itemName": "string",
            "rateFactors": [
                {
                    "key": "string",
                    "rateFactor": {
                        "contextMeteringItem": "string",
                        "rateFactor": "number"
                    },
                    "value": "string"
                }
            ]
        }
    ],
    "unconditionalMeterings": [
        {
            "itemName": "string",
            "unconditionalMetering": {
                "chargePeriod": "string",
                "rate": "number"
            }
        }
    ]
}
string
chargeModel
Required

The charge model of the pricing policy

Possible values are : ALLOCATION_POOL, RESERVATION_POOL, PAY_AS_YOU_GO, UNKNOWN,
string
createdBy
Optional

The policy creator

Possible values are : VRA, TA, TA_VCD, TA_VC, VROPS, UNKNOWN,
string
description
Optional

description

string As uuid As uuid
id
Optional

The UUID of the policy.
Note: It is required during update.

integer As int64 As int64
lastUpdateTimestamp
Optional

The last update timestamp of the policy

array of link
links
Optional

links

array of MeteringItem
meterings
Optional

Collection of metering items

string
name
Required

The pricing policy name

array of NamedMeteringItem
namedMeterings
Optional

Collection of named metering items

array of OneTimeMeteringItem
oneTimeMeterings
Optional

oneTimeMeterings

array of TagBasedMeteringItem
tagBasedMeterings
Optional

Collection of tag based metering items

array of TagBasedOneTimeMeteringItem
tagBasedOneTimeMeterings
Optional

tagBasedOneTimeMeterings

array of TagBasedPolicyRefItem
tagBasedPolicyRefs
Optional

tagBasedPolicyRefs

array of TagBasedRateFactorItem
tagBasedRateFactors
Optional

tagBasedRateFactors

array of UnconditionalMeteringItem
unconditionalMeterings
Optional

Collection of unconditional metering items


422

An invalid request body was specified or any constraints were violated

Operation doesn't return any data structure

500

There was an error during the update of the pricing policy

Operation doesn't return any data structure

On This Page
Pricing Policies Operations
POST
Create Metering Policy Using POST
DELETE
Delete Metering Policy Using DELETE
GET
Get Pricing Policies Using GET
GET
Get Pricing Policy History Using GET
GET
Get Pricing Policy Using GET
PUT
Update Metering Policy Using PUT