Create Policy

Create Policy

Create a new pricing card based on request body and validate its field according to business rules.

Request
URI
POST
https://{api_host}/price/api/private/pricing-cards
COPY
Request Body
MeteringPolicy of type(s) application/json
Required

Show optional properties

{
    "name": "string"
}
{
    "chargeModel": "string",
    "createdAt": "string",
    "createdBy": "string",
    "description": "string",
    "fixedPrice": {
        "chargePeriod": "string",
        "rate": "number"
    },
    "id": "string",
    "lastUpdatedAt": "string",
    "meteringItems": [
        {
            "itemName": "string",
            "metering": {
                "baseRate": "number",
                "chargeBasedOn": "string",
                "chargeOnPowerState": "string",
                "chargePeriod": "string",
                "fixedPrice": "number",
                "unit": "string"
            }
        }
    ],
    "name": "string",
    "namedMeteringItems": [
        {
            "itemName": "string",
            "namedMeterings": [
                {
                    "metering": {
                        "baseRate": "number",
                        "chargeBasedOn": "string",
                        "chargeOnPowerState": "string",
                        "chargePeriod": "string",
                        "fixedPrice": "number",
                        "unit": "string"
                    },
                    "name": "string"
                }
            ]
        }
    ],
    "oneTimeMeteringItems": [
        {
            "itemName": "string",
            "oneTimeMetering": {
                "oneTimeFixedPrice": "number"
            }
        }
    ],
    "orgId": "string",
    "pricingCardAssignmentInfo": {
        "count": 0,
        "entityType": "string"
    },
    "tagBasedMeteringItems": [
        {
            "itemName": "string",
            "tagBasedMeterings": [
                {
                    "key": "string",
                    "metering": {
                        "baseRate": "number",
                        "chargeBasedOn": "string",
                        "chargeOnPowerState": "string",
                        "chargePeriod": "string",
                        "fixedPrice": "number",
                        "unit": "string"
                    },
                    "value": "string"
                }
            ]
        }
    ],
    "tagBasedOneTimeMeteringItems": [
        {
            "itemName": "string",
            "oneTimeMeterings": [
                {
                    "key": "string",
                    "oneTimeMetering": {
                        "oneTimeFixedPrice": "number"
                    },
                    "value": "string"
                }
            ]
        }
    ],
    "tagBasedRateFactorItems": [
        {
            "itemName": "string",
            "rateFactors": [
                {
                    "key": "string",
                    "rateFactor": {
                        "contextMeteringItem": "string",
                        "rateFactor": "number"
                    },
                    "value": "string"
                }
            ]
        }
    ]
}
string
chargeModel
Optional

chargeModel

string As date-time As date-time
createdAt
Optional

createdAt

string
createdBy
Optional

createdBy

string
description
Optional

description

object
fixedPrice
Optional

fixedPrice

string As uuid As uuid
id
Optional

id

string As date-time As date-time
lastUpdatedAt
Optional

lastUpdatedAt

array of object
meteringItems
Optional

meteringItems

string
name
Required

name

array of object
namedMeteringItems
Optional

namedMeteringItems

array of object
oneTimeMeteringItems
Optional

oneTimeMeteringItems

string
orgId
Optional

orgId

object
pricingCardAssignmentInfo
Optional

Assignment count, assignment entity type

array of object
tagBasedMeteringItems
Optional

tagBasedMeteringItems

array of object
tagBasedOneTimeMeteringItems
Optional

tagBasedOneTimeMeteringItems

array of object
tagBasedRateFactorItems
Optional

tagBasedRateFactorItems

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MeteringPolicy of type(s) application/json 
"MeteringPolicy Object"
string
chargeModel
Optional

chargeModel

string As date-time As date-time
createdAt
Optional

createdAt

string
createdBy
Optional

createdBy

string
description
Optional

description

object
fixedPrice
Optional

fixedPrice

string As uuid As uuid
id
Optional

id

string As date-time As date-time
lastUpdatedAt
Optional

lastUpdatedAt

array of object
meteringItems
Optional

meteringItems

string
name
Required

name

array of object
namedMeteringItems
Optional

namedMeteringItems

array of object
oneTimeMeteringItems
Optional

oneTimeMeteringItems

string
orgId
Optional

orgId

object
pricingCardAssignmentInfo
Optional

Assignment count, assignment entity type

array of object
tagBasedMeteringItems
Optional

tagBasedMeteringItems

array of object
tagBasedOneTimeMeteringItems
Optional

tagBasedOneTimeMeteringItems

array of object
tagBasedRateFactorItems
Optional

tagBasedRateFactorItems


201

Created

Returns MeteringPolicy of type(s) application/json 
"MeteringPolicy Object"
string
chargeModel
Optional

chargeModel

string As date-time As date-time
createdAt
Optional

createdAt

string
createdBy
Optional

createdBy

string
description
Optional

description

object
fixedPrice
Optional

fixedPrice

string As uuid As uuid
id
Optional

id

string As date-time As date-time
lastUpdatedAt
Optional

lastUpdatedAt

array of object
meteringItems
Optional

meteringItems

string
name
Required

name

array of object
namedMeteringItems
Optional

namedMeteringItems

array of object
oneTimeMeteringItems
Optional

oneTimeMeteringItems

string
orgId
Optional

orgId

object
pricingCardAssignmentInfo
Optional

Assignment count, assignment entity type

array of object
tagBasedMeteringItems
Optional

tagBasedMeteringItems

array of object
tagBasedOneTimeMeteringItems
Optional

tagBasedOneTimeMeteringItems

array of object
tagBasedRateFactorItems
Optional

tagBasedRateFactorItems


401

Unauthorized

Returns MeteringPolicy of type(s) application/json 
"MeteringPolicy Object"
string
chargeModel
Optional

chargeModel

string As date-time As date-time
createdAt
Optional

createdAt

string
createdBy
Optional

createdBy

string
description
Optional

description

object
fixedPrice
Optional

fixedPrice

string As uuid As uuid
id
Optional

id

string As date-time As date-time
lastUpdatedAt
Optional

lastUpdatedAt

array of object
meteringItems
Optional

meteringItems

string
name
Required

name

array of object
namedMeteringItems
Optional

namedMeteringItems

array of object
oneTimeMeteringItems
Optional

oneTimeMeteringItems

string
orgId
Optional

orgId

object
pricingCardAssignmentInfo
Optional

Assignment count, assignment entity type

array of object
tagBasedMeteringItems
Optional

tagBasedMeteringItems

array of object
tagBasedOneTimeMeteringItems
Optional

tagBasedOneTimeMeteringItems

array of object
tagBasedRateFactorItems
Optional

tagBasedRateFactorItems


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}' https://{api_host}/price/api/private/pricing-cards
On This Page
Pricing Cards Operations
GET
Get Policies
POST
Create Policy
DELETE
Delete Policy
GET
Get Policy
PUT
Update Policy