ProductTiers
This entity describes the pricing and costing tiers for a specific billing product on the Product table. It allows you to configure tiered or volume pricing for the billing product.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
Entity Name: | ProductTiers |
Entity Path: |
/atservicesrest/v1.0/ProductTiers |
Parent Entity: | Products |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
General
- If the product's Price/Cost Method is Standard, Product Tiers cannot be created.
- To query, you must have View permission and (Admin > Products OR Inventory module access (site installed module access only))
- To create or update, you must have View and Create permission and (Admin > Products OR Inventorymodule access (site installed module access only))
Special field attributes
Field | Conditions and Requirements |
---|---|
productID | This field must be supplied during create. On update, it is read-only. |
unitCost |
This entity field will return no information if the user account making the query does not have sufficient privileges to view cost data in the Autotask UI. Additionally, if an update request does not have the necessary permissions, the API will ignore the call's values for the field even if they are blank or would be otherwise required. |
unitPrice | In multi-currency databases, this will be in the internal currency. |
Field definitions
The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
To learn how to query picklist endpoints, refer to Understanding picklists.
Notes
- For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
- If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
- You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|
id | long | ||||
productID | integer | Products | |||
unitCost | decimal | ||||
unitPrice | decimal | ||||
upToUnitCount | decimal |