ServicePrice

ServicePrice

Version: 1.33

Parameters

Extends: TractObject

Elements
Element	Type	Required?	Description
CHOICE: oneTimeProductPrice recurringProductPrice	oneTimeProductPrice recurringProductPrice	Y	The price of the product for this service.
promotion	promotion		A promotion that applies to the price.
servicePriceRanges	servicePriceRanges		The ranges for tiered pricing based on service quantity.
scheduledCharges	scheduledCharges		A list of scheduled charges for this service price.

Attributes
Attribute	Required?	Datatype	Description
amount		decimal	The total service price.
startDate		dateTime	The effective date for this price.
endDate		dateTime	The date this price ends.
billInAdvance		boolean	Is this price set to bill in advance?
recurrencePeriod		RecurrencePeriod	BILLCYCLE DAY FOURYEARS FIVEYEARS MONTH QUARTER THREEYEARS TWICEAMONTH TWICEAYEAR TWOWEEKS TWOYEARS WEEK YEAR FOURMONTHS
estimatedInvoiceAmount		decimal	An estimated total invoice amount.
invoiceQuantity		decimal	How many invoices will this price generate?
prorateOnCancel		boolean

Querying ServicePrice

For paged results, use the plural of the entity name (for example, billingAccounts, productCategories). For more information, refer to Understanding Queries.

Query Keys
Key	Type
eid	Long
serviceEid	Long
startDate	Timestamp
endDate	Timestamp
recurrencePeriod	RecurrencePeriod
productPriceEid	Long

REST Endpoints

getServicePrices	GET	https://my.tractbilling.com/t/s/r/1.33/servicePrices
getServicePrice	GET	https://my.tractbilling.com/t/s/r/1.33/servicePrices/{eid: \d+}