Get Pricing Policy Using GET

Get Pricing Policy Using GET

Get the pricing policy for the specified identifier

Request
URI
GET
https://{api_host}/api/pricing/{id}
COPY
Path Parameters
string
id
Required

The pricing policy identifier


Authentication
This operation uses the following authentication methods.
Responses
200

The pricing policy for the specified identifier

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

meterings
Optional

Collection of metering items

string
name
Required

The pricing policy name

namedMeterings
Optional

Collection of named metering items

oneTimeMeterings
Optional

oneTimeMeterings

tagBasedMeterings
Optional

Collection of tag based metering items

tagBasedOneTimeMeterings
Optional

tagBasedOneTimeMeterings

tagBasedPolicyRefs
Optional

tagBasedPolicyRefs

tagBasedRateFactors
Optional

tagBasedRateFactors

unconditionalMeterings
Optional

Collection of unconditional metering items


404

There is no pricing policy for the specified identifier

Operation doesn't return any data structure