ProductTier
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.
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.
Entity details
You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.
Entity Name: | ProductTier |
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 Inventorymodule access (site installed module access only))
- To create/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 |
---|---|
UnitPrice | In Multi-currency databases, this will be in the internal currency. |
ProductID | This field must be supplied during create(). On update(), it is read-only. |
ProductVendor |
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. |
Field definitions
The following table describes the standard Autotask field objects for this entity.
- To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
- For information on entity UDFs, use getUDFInfo().
- For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
- LT indicates Local Term.
For more information about fields marked as picklists, review our Understanding picklists article.
Field Name | Label | Datatype | Read Only | Is Required | Reference Name | Picklist |
---|---|---|---|---|---|---|
id | Product Tier ID | long | ||||
ProductID | Product ID | integer | Product | |||
UnitCost | Unit Cost | decimal | ||||
UnitPrice | Unit Price | decimal | ||||
UpToUnitCount | Up To Unit Count | decimal |