Get Price Model Item Charges
get
/rest/v16/pricingSetup/models/{modelVarName}/priceModelItems/{priceModelItemId}/charges
Use this endpoint to retrieve all charges for the specified price model item.
Request
Path Parameters
Query Parameters
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderby: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
-
totalResults: boolean
The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : PricingResourceCollection_PricingCharge
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
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 : 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 : 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 : 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