Jump to

• Request
• Response
• Examples

Update Price Model Item Charge

patch

/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/charges/{id}

Use this endpoint to update a price model item charge.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer(int64)
• modelVarName(required): string
• priceModelItemId(required): integer(int64)

Body ()

Root Schema : PricingCharge

Type: object

Show Source

• blockPrices: array Block Prices
  Title: Block Prices

  The block price.
• blockSize: number()
  Title: Block Size

  The block size.
• chargeDefinition: string()
  Title: Charge Definition

  Read Only: true

  Display Name of the Charge Definition.
• chargeDefinitionCode: string()
  Title: Charge Definition Code

  The unique code of the Charge Definition.
• chargeDefinitionId: integer()
  Title: Charge Definition ID

  Read Only: true

  ID of the Charge Definition.
• chargeType: string()
  Title: Charge Type

  The category of charge.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation date.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date.
• dynamicPricingType: string()
  Title: Dynamic Pricing Type

  Allowed Values: [ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]

  The dynamic pricing type of the charge.
• endDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: End Date

  The date at which the Charge will end.
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Charge.
• integrationId: string()
  Title: Integration Id

  Read Only: true

  Rate Plan Charge ID from SCM.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• pricePeriod: string()
  Title: Price Period

  The billing period.
• prices: array Prices
  Title: Prices

  The item prices.
• priceType: string()
  Title: Price Type

  The type of charge.
• pricingMatrixVariableName: string()
  Title: Pricing Matrix Variable Name

  Pricing Matrix variable name (Preview only. Not available for use.)
• primaryCharge: boolean()
  Title: Primary Charge

  Indicates whether this is the primary charge.
• rateCardName: string()
  Title: Rate Card Name

  Read Only: true

  Rate Card name (Preview only. Not available for use.)
• rateCardVariableName: string()
  Title: Rate Card Variable Name

  Rate Card variable name (Preview only. Not available for use.)
• startDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Start Date

  The date from which the Charge will be applicable.
• templateVariableName: string()
  Title: Pricing Matrix Template Variable Name

  The pricing matrix emplate variable name.
• tiers: array Tiers
  Title: Tiers

  The charge tiers.
• usageUOM: string()
  Title: Usage UOM

  The unit of measure for the charge.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Charge.",
            "title":"Id",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date.",
            "title":"Date Added",
            "readOnly":true
        },
        "prices":{
            "type":"array",
            "format":"",
            "description":"The item prices.",
            "title":"Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        },
        "startDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date from which the Charge will be applicable.",
            "title":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date at which the Charge will end.",
            "title":"End Date"
        },
        "chargeDefinition":{
            "type":"string",
            "format":"",
            "description":"Display Name of the Charge Definition.",
            "title":"Charge Definition",
            "readOnly":true
        },
        "chargeDefinitionCode":{
            "type":"string",
            "format":"",
            "description":"The unique code of the Charge Definition.",
            "title":"Charge Definition Code"
        },
        "chargeDefinitionId":{
            "type":"integer",
            "format":"",
            "description":"ID of the Charge Definition.",
            "title":"Charge Definition ID",
            "readOnly":true
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"Rate Plan Charge ID from SCM.",
            "title":"Integration Id",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "primaryCharge":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this is the primary charge.",
            "title":"Primary Charge"
        },
        "chargeType":{
            "type":"string",
            "format":"",
            "description":"The category of charge.",
            "title":"Charge Type"
        },
        "priceType":{
            "type":"string",
            "format":"",
            "description":"The type of charge.",
            "title":"Price Type"
        },
        "pricePeriod":{
            "type":"string",
            "format":"",
            "description":"The billing period.",
            "title":"Price Period"
        },
        "usageUOM":{
            "type":"string",
            "format":"",
            "description":"The unit of measure for the charge.",
            "title":"Usage UOM"
        },
        "rateCardVariableName":{
            "type":"string",
            "format":"",
            "description":"Rate Card variable name (Preview only. Not available for use.)",
            "title":"Rate Card Variable Name"
        },
        "rateCardName":{
            "type":"string",
            "format":"",
            "description":"Rate Card name (Preview only. Not available for use.)",
            "title":"Rate Card Name",
            "readOnly":true
        },
        "dynamicPricingType":{
            "type":"string",
            "format":"",
            "description":"The dynamic pricing type of the charge.",
            "title":"Dynamic Pricing Type",
            "enum":[
                "static",
                "advanced",
                "volume",
                "tiered",
                "rateCard",
                "attributeBasedCharge"
            ]
        },
        "tiers":{
            "type":"array",
            "format":"",
            "description":"The charge tiers.",
            "title":"Tiers",
            "items":{
                "$ref":"#/definitions/ChargeTier"
            }
        },
        "blockSize":{
            "type":"number",
            "format":"",
            "description":"The block size.",
            "title":"Block Size"
        },
        "blockPrices":{
            "type":"array",
            "format":"",
            "description":"The block price.",
            "title":"Block Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        },
        "pricingMatrixVariableName":{
            "type":"string",
            "format":"",
            "description":"Pricing Matrix variable name (Preview only. Not available for use.)",
            "title":"Pricing Matrix Variable Name"
        },
        "templateVariableName":{
            "type":"string",
            "format":"",
            "description":"The pricing matrix emplate variable name.",
            "title":"Pricing Matrix Template Variable Name"
        }
    }
}

Nested Schema : Block Prices

Type: array

Title: Block Prices

The block price.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The block price.",
    "title":"Block Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Prices

Type: array

Title: Prices

The item prices.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The item prices.",
    "title":"Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Nested Schema : Tiers

Type: array

Title: Tiers

The charge tiers.

Show Source

• Array of: object ChargeTier

{
    "type":"array",
    "format":"",
    "description":"The charge tiers.",
    "title":"Tiers",
    "items":{
        "$ref":"#/definitions/ChargeTier"
    }
}

Nested Schema : PricingCurrencyValues

Type: object

Show Source

• currencyCode: string()
  Title: Currency Code

  The currency code.
• value: number()
  Title: Value

  The currency value.

{
    "properties":{
        "currencyCode":{
            "type":"string",
            "format":"",
            "description":"The currency code.",
            "title":"Currency Code"
        },
        "value":{
            "type":"number",
            "format":"",
            "description":"The currency value.",
            "title":"Value"
        }
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : ChargeTier

Type: object

Show Source

• blockPrices: array Block Prices
  Title: Block Prices

  The block price for the corresponding tier.
• blockSize: number()
  Title: Block Size

  The block size for the corresponding tier.
• prices: array Prices
  Title: Prices

  The prices.
• rangeFrom: number()
  Title: Range From

  The starting range of the Charge.
• rangeTo: number()
  Title: Range To

  Read Only: true

  The ending range of the Charge.

{
    "properties":{
        "rangeFrom":{
            "type":"number",
            "format":"",
            "description":"The starting range of the Charge.",
            "title":"Range From"
        },
        "rangeTo":{
            "type":"number",
            "format":"",
            "description":"The ending range of the Charge.",
            "title":"Range To",
            "readOnly":true
        },
        "prices":{
            "type":"array",
            "format":"",
            "description":"The prices.",
            "title":"Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        },
        "blockSize":{
            "type":"number",
            "format":"",
            "description":"The block size for the corresponding tier.",
            "title":"Block Size"
        },
        "blockPrices":{
            "type":"array",
            "format":"",
            "description":"The block price for the corresponding tier.",
            "title":"Block Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        }
    }
}

Nested Schema : Block Prices

Type: array

Title: Block Prices

The block price for the corresponding tier.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The block price for the corresponding tier.",
    "title":"Block Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Nested Schema : Prices

Type: array

Title: Prices

The prices.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The prices.",
    "title":"Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Back to Top

Response

204 Response

Success

Back to Top

Examples

The following examples show how to update a Price Model Item charge by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X PATCH - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/pricingSetup/models/_defaultPriceModel/priceModelItems/36964026/charges/3022960005

Request Body Sample

{
  "prices": [{
      "currencyCode": "USD",
      "value": 30
    }, {
      "currencyCode": "GBP",
      "value": 40
    }, {
      "currencyCode": "JPY",
      "value": 50
    }
  ]
}

Back to Top