Get Pricing Policies Using GET

Get Pricing Policies Using GET

Get a listing of all pricing policies

Request
URI
GET
https://{api_host}/api/pricing
COPY
Query Parameters
string of array
createdBy
Optional

Filter by Creator of the policy

Possible values are : VRA, TA, TA_VCD, TA_VC, VROPS, UNKNOWN,

Authentication
This operation uses the following authentication methods.
Responses
200

The list of all pricing policies

Returns pricing-policies of type(s) application/json
{
    "policies": [
        {
            "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"
                    }
                }
            ]
        }
    ]
}
policies
Optional

Collection of Pricing policy details


500

There was an error while returning the pricing policy

Operation doesn't return any data structure