Update Price Agreement Rate Plan Charge
patch
/rest/v16/pricingSetup/agreements/{agreementVarName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id}
Use this endpoint to update the specified price agreement item rate plan charge.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : PricingCharge
Type:
Show Source
object
-
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.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
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
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : PricingCurrencyValues
Type:
Show Source
object
-
currencyCode:
string()
Title:
Currency Code
The currency code. -
value:
number()
Title:
Value
The currency value.
Nested Schema : UserDetails
Type:
Show Source
object
-
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
Nested Schema : ChargeTier
Type:
Show Source
object
-
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.
Nested Schema : Block Prices
Type:
array
Title:
Block Prices
The block price for the corresponding tier.
Show Source
Response
204 Response
Success
Examples
The following examples show how to update the specified price agreement item rate plan 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/agreements/promoAPIaccount112/priceAgreementItems/3023155942/ratePlans/rateAPI/charges/3023156096
Request Body Sample
{ "prices": [{ "currencyCode": "USD", "value": 200 } ], "chargeType": "ORA_SALE", "priceType": "One Time", "dynamicPricingType": "static" }