OneTimeProductPrice

Version: 1.33

ProductPrice is either a RecurringProductPrice or a OneTimeProductPrice .

OneTimeProductPrice is optional in Gotransverse (a RecurringProductPrice is required in Gotransverse to sell your Product to your Customers). You can use a OneTimeProductPrice in addition to your Product's RecurringProductPrice. The OneTimeProductPrice is a "one time" charge on the Product.

In the Gotransverse API, OneTimeProductPrice is queried directly and used in ProductPrices that in turn is used in Product.

Parameters

Each OneTimeProductPrice shown from the Query shows information for a number of elements in the entity. The following table shows the elements, details of the elements, and brief descriptions.

Parameters
Element Name	Query Key	Element Type	Field Length	Required to Create	Description
queryScope		QueryScope	- -	No	Whether default query results are overridden by QueryScope resulting i SHALLOW or DEEP query results. See QueryScope for details.
eid	Yes	Long	System Generated	System Generated	System generated unique identity number assigned to all entities in Gotransverse.
priceRanges		Sequence of PriceRange	- -	Yes	Each price range is a tier in a price. For example: Buy 1-2 and the price for each is $80.00 Buy 3-8 and the price for each is $45.00 Buy 9 or more and the price for each is $20.00 Each of the 3 tiers has a price which is the price range.
productUsageRules		ProductUsageRule	- -	Conditional	Product Usage Rules are created in the GUI. If your Product needs one or more Product Usage Rules, they are used here.
fromDate	Yes	dateTime	Refer to Data Types for dateTime formats.	Yes	The date the price starts.
thruDate	Yes	dateTime	Refer to Data Types for dateTime formats.	No	The last date the price is used.
priceOverride		Boolean	Enter either: "true" (Yes) or "false" (No)	Yes	Can this One Time Product Price be overridden?
allowScheduledCharges		Boolean		Yes	Can this Recurring Product Price have scheduled charges?.
type		PriceType	- -	Yes	Choose the PriceType: OneTime or Recurring.
paymentOnPurchaseRequired		Boolean	True or false	Yes	Do you require a payment for this Product when it is purchased?
currencyType	Yes	CurrencyType	- -	Returned in Query Results	The type of currency used. See CurrencyType for list of currencies.
chargeDuringRenewal	Yes	Boolean	True or false	No	Do you require a charge for this Product when it is renewed?
grantedValue		string			The value granted to a prepaid balance upon purchase of this product.
autoContributionOverride		Boolean			When true, the automatic contribution fields are exposed and must be filled out.
autoContributionAmount		string			The amount to charge for future automatic contributions.
autoContributionThreshold		string			The granted value threshold for when an automatic contribution occurs.
autoContributionGrantedValue		string			The granted value gained when an automatic contribution occurs.

The dateTime format: yyyy-mm-ddThh:mm:ss.sss-06:00 The GMT offset is 6 hours. For example, 2011-01-28T16:17:22.234-06:00. Refer to Data Types for further information and for a list of dateTime formats accepted by Gotransverse.

Entity OneTimeProductPrices

The entity OneTimeProductPrices enables you to see multiple pages of the entity OneTimeProductPrice.

Elements
Element Name	Element Type	Field Length	Description
pageNumber	Integer	as needed	Shows the current page number.
pageSize	Integer	as needed	Shows the page size.
totalElements	Long	as needed	Shows the total number of items found.
elementCount	Integer	as needed	Shows the current count of the item in the number of items that were found.
totalPages	Integer	as needed	Shows the total number of pages.
oneTimeProductPrices	OneTimeProductPrice	- -	Shows the list of OneTimeProductPrices.

Information for the related entity of ProductPrices:

Entity OneTimeProductPrices

Query a OneTimeProductPrice

Query Key Information for SOAP and REST

To query OneTimeProductPrice or ProductPrice (shows both OneTimeProductPrice AND RecurringProductPrice) you need to include a parameter for which you are querying. The first table shows the query keys for OneTimeProductPrice and the second table shows the query keys for ProductPrice. If you do not know the value for the parameter, query separately to learn the value.

Query Key Parameters for OneTimeProductPrice for SOAP and REST

OneTimeProductPrice
Query Key	Value	Definition
eid	Long	The eid number of the ProductPrice.
productEid	Long	The eid number of the Product.
fromDate	DateTime	The date this Price of the Product started.
thruDate	DateTime	The last date this Price of the Product can be used.
priceListEid	Long	If a Price List is used, the eid number of the Price List.
priceListIsMaster	Boolean	If a Price List is used, is this Price List the Master Price List or not?
currencyType	Decimal	The type of currency that is used. See CurrencyType for list of currencies.
chargeDuringRenewal	Boolean	Do you require a charge during renewal this Product?

Query Key Parameters for ProductPrice for SOAP and REST

ProductPrice
Query Key	Value	Definition
eid	Long	The eid number of the ProductPrice.
productEid	Long	The eid number of the Product.
fromDate	DateTime	The date this Price of the Product started.
thruDate	DateTime	The last date this Price of the Product can be used.
priceListEid	Long	If a Price List is used, the eid number of the Price List.
priceListIsMaster	Boolean	If a Price List is used, is this Price List the Master Price List or not?
currencyType	Decimal	The type of currency that is used. Refer to CurrencyType for list of currencies.

Query to Use
Query to Use	Query for	Parameter Name and Value	Returns
SimpleDataQuery	OneTimeProductPrice	<parameter name><parameter value>	List of your OneTimeProductPrices for that parameter name and value.
SimpleDataQuery	ProductPrice	<parameter name><parameter value>	List of your ProductPrices (both RecurringProductPrices and OneTimeProductPrices) for that parameter name and value.

SOAP Example Query and Response

In the following example SOAP query, the parameter of productEid was used. The following query is for ProductPrice and shows BOTH RecurringProductsPrices and OneTimeProductPrices. The Product's EID value (in this example "1301"), was learned through a previous query on Product. To see just the OneTimeProductPrices replace "ProductPrice" with "OneTimeProductPrice" and the results show just OneTimeProductPrices.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
			<soap:Body>
			<ns2:query xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
			<ns2:queryRequest>
			<simpleDataQuery startIndex="0" size="50">
			<type>ProductPrice</type>
			<parameter parameter="productEid" parameterValue="1301"/>
			</simpleDataQuery>
			</ns2:queryRequest>
			</ns2:query>
			</soap:Body>
		</soap:Envelope>

This was the response showing both RecurringProductPrices and OneTimeProductPrices:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
			<soap:Body>
			<ns2:queryResponse xmlns="http://www.tractbilling.com/billing/1_31/domain"xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
			<ns2:return successful="true">
			<productPrices pageNumber="1" pageSize="50" totalElements="5" elementCount="5" totalPages="1">
			<recurringProductPrice recurringPaymentRequired="false" recurrencePeriod="BILLCYCLE" recurrenceAmount="0.00000" proratedOnOrder="false" proratedOnCancel="false" proratedOnOrderNoCharge="false" billInAdvance="true" fromDate="2012-02-01T00:00:00.000-06:00" thruDate="2012-03-09T00:00:00.000-06:00" priceOverride="false" type="Recurring" paymentOnPurchaseRequired="false" currencyType="USD" eid="1811" queryScope="SHALLOW">
			<priceRanges pageNumber="1" pageSize="50" totalElements="1" 
			elementCount="0" totalPages="1"/>
			<productUsageRules pageNumber="1" pageSize="50" totalElements="0" 
			elementCount="0" totalPages="0"/>
			</recurringProductPrice>
			<recurringProductPrice recurringPaymentRequired="false" recurrencePeriod="BILLCYCLE" recurrenceAmount="0.00000" proratedOnOrder="false" proratedOnCancel="false" proratedOnOrderNoCharge="false" billInAdvance="true" fromDate="2012-03-09T00:00:00.000-06:00" thruDate="2012-03-12T00:00:00.000-05:00" priceOverride="false" type="Recurring" paymentOnPurchaseRequired="false" currencyType="USD" eid="1812" queryScope="SHALLOW">
			<priceRanges pageNumber="1" pageSize="50" totalElements="1" 
			elementCount="0" totalPages="1"/>
			<productUsageRules pageNumber="1" pageSize="50" totalElements="0" 
			elementCount="0" totalPages="0"/>
			</recurringProductPrice>
			<recurringProductPrice recurringPaymentRequired="false" recurrencePeriod="BILLCYCLE" recurrenceAmount="0.00000" proratedOnOrder="false" proratedOnCancel="false" proratedOnOrderNoCharge="false" billInAdvance="true" fromDate="2012-03-12T00:00:00.000-05:00" priceOverride="true" type="Recurring" paymentOnPurchaseRequired="false" currencyType="USD" eid="1821" queryScope="SHALLOW">
			<priceRanges pageNumber="1" pageSize="50" totalElements="1" 
			elementCount="0" totalPages="1"/>
			<productUsageRules pageNumber="1" pageSize="50" totalElements="0" 
			elementCount="0" totalPages="0"/>
			</recurringProductPrice>
			<oneTimeProductPrice chargeDuringRenewal="false" fromDate="2012-11-27T00:00:00.000-06:00" thruDate="2013-07-01T00:00:00.000-05:00" priceOverride="false" type="OneTime" paymentOnPurchaseRequired="false" currencyType="USD" eid="4241" queryScope="SHALLOW">
			<priceRanges pageNumber="1" pageSize="50" totalElements="3" 
			elementCount="0" totalPages="1"/>
			<productUsageRules pageNumber="1" pageSize="50" totalElements="0" 
			elementCount="0" totalPages="0"/>
			</oneTimeProductPrice>
			<oneTimeProductPrice chargeDuringRenewal="false" fromDate="2013-07-01T00:00:00.000-05:00" priceOverride="false" type="OneTime" paymentOnPurchaseRequired="false" currencyType="USD" eid="5797" queryScope="SHALLOW">
			<priceRanges pageNumber="1" pageSize="50" totalElements="3" 
			elementCount="0" totalPages="1"/>
			<productUsageRules pageNumber="1" pageSize="50" totalElements="0" 
			elementCount="0" totalPages="0"/>
			</oneTimeProductPrice>
			</productPrices>
			</ns2:return>
			</ns2:queryResponse>
			</soap:Body>
		</soap:Envelope>

REST Mount Points

REST Mount Point and Parameters for OneTimeProductPrices

Query

GET https://my.tractbilling.com/t/s/r/1.33/oneTimeProductPrices/<eid>
GET https://my.tractbilling.com/t/s/r/1.33/oneTimeProductPrices?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/oneTimeProductPrices?productEid=<productEid>
GET https://my.tractbilling.com/t/s/r/1.33/oneTimeProductPrices?fromDate=<fromDate>
GET https://my.tractbilling.com/t/s/r/1.33/oneTimeProductPrices?thruDate=<thruDate>
GET https://my.tractbilling.com/t/s/r/1.33/oneTimeProductPrices?priceListEid=<priceListEid>
GET https://my.tractbilling.com/t/s/r/1.33/oneTimeProductPrices?priceListIsMaster=<priceListIsMaster>
GET https://my.tractbilling.com/t/s/r/1.33/oneTimeProductPrices?currencyType=<currencyType>
GET https://my.tractbilling.com/t/s/r/1.33/oneTimeProductPrices?chargeDuringRenewal=<chargeDuringRenewal>

REST Mount Point and Parameters for ProductPrices

Query

GET https://my.tractbilling.com/t/s/r/1.33/productPrices/<eid>
GET https://my.tractbilling.com/t/s/r/1.33/productPrices?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/productPrices?productEid=<productEid>
GET https://my.tractbilling.com/t/s/r/1.33/productPrices?fromDate=<fromDate>
GET https://my.tractbilling.com/t/s/r/1.33/productPrices?thruDate=<thruDate>
GET https://my.tractbilling.com/t/s/r/1.33/productPrices?priceListEid=<priceListEid>
GET https://my.tractbilling.com/t/s/r/1.33/productPrices?priceListIsMaster=<priceListIsMaster>
GET https://my.tractbilling.com/t/s/r/1.33/productPrices?currencyType=<currencyType>

REST Example Query and Response for OneTimeProductPrices

In the following example REST query, the parameter of productEid was used. The Product's EID value (in this example "1301"), was learned through a previous query on Product.

GET https://my.tractbilling.com/t/s/r/1.33/oneTimeProductPrices?productEid=1301

This was the response (line breaks and formatting added for ease of reading):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
			<onetimeProductPrices xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
			<ns2:oneTimeProductPrice chargeDuringRenewal="false" fromDate="2012-11-27T00:00:00.000-06:00" thruDate="2013-07-01T00:00:00.000-05:00" priceOverride="false" type="OneTime" paymentOnPurchaseRequired="false" currencyType="USD" eid="4241" queryScope="SHALLOW">
			<ns2:priceRanges pageNumber="1" pageSize="50" totalElements="3" 
			elementCount="0" totalPages="1"/>
			<ns2:productUsageRules pageNumber="1" pageSize="50" 
			totalElements="0" elementCount="0" totalPages="0"/>
			</ns2:oneTimeProductPrice>
			<ns2:oneTimeProductPrice chargeDuringRenewal="false" fromDate="2013-07-01T00:00:00.000-05:00" priceOverride="false" type="OneTime" paymentOnPurchaseRequired="false" currencyType="USD" eid="5797" queryScope="SHALLOW">
			<ns2:priceRanges pageNumber="1" pageSize="50" totalElements="3" 
			elementCount="0" totalPages="1"/>
			<ns2:productUsageRules pageNumber="1" pageSize="50" 
			totalElements="0" elementCount="0" totalPages="0"/>
			</ns2:oneTimeProductPrice>
		</onetimeProductPrices>

REST Example Query and Response for ProductPrices

In the following example REST query, the parameter of productEid was used. The Product's EID value (in this example "1301"), was learned through a previous query on Product.

GET https://my.tractbilling.com/t/s/r/1.33/productPrices?productEid=1301

This was the response (line breaks and formatting added for ease of reading):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
			<productPrices xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="5" elementCount="5" totalPages="1">
			<ns2:recurringProductPrice recurringPaymentRequired="false" recurrencePeriod="BILLCYCLE" recurrenceAmount="0.00000" proratedOnOrder="false" proratedOnCancel="false" proratedOnOrderNoCharge="false" billInAdvance="true" fromDate="2012-02-01T00:00:00.000-06:00" thruDate="2012-03-09T00:00:00.000-06:00" priceOverride="false" type="Recurring" paymentOnPurchaseRequired="false" currencyType="USD" eid="1811" queryScope="SHALLOW">
			<ns2:priceRanges pageNumber="1" pageSize="50" 
			totalElements="1" elementCount="0" totalPages="1"/>
			<ns2:productUsageRules pageNumber="1" pageSize="50" 
			totalElements="0" elementCount="0" totalPages="0"/>
			</ns2:recurringProductPrice>
			<ns2:recurringProductPrice recurringPaymentRequired="false" recurrencePeriod="BILLCYCLE" recurrenceAmount="0.00000" proratedOnOrder="false" proratedOnCancel="false" proratedOnOrderNoCharge="false" billInAdvance="true" fromDate="2012-03-09T00:00:00.000-06:00" thruDate="2012-03-12T00:00:00.000-05:00" priceOverride="false" type="Recurring" paymentOnPurchaseRequired="false" currencyType="USD" eid="1812" queryScope="SHALLOW">
			<ns2:priceRanges pageNumber="1" pageSize="50" 
			totalElements="1" elementCount="0" totalPages="1"/>
			<ns2:productUsageRules pageNumber="1" pageSize="50" 
			totalElements="0" elementCount="0" totalPages="0"/>
			</ns2:recurringProductPrice>
			<ns2:recurringProductPrice recurringPaymentRequired="false" recurrencePeriod="BILLCYCLE" recurrenceAmount="0.00000" proratedOnOrder="false" proratedOnCancel="false" proratedOnOrderNoCharge="false" billInAdvance="true" fromDate="2012-03-12T00:00:00.000-05:00" priceOverride="true" type="Recurring" paymentOnPurchaseRequired="false" currencyType="USD" eid="1821" queryScope="SHALLOW">
			<ns2:priceRanges pageNumber="1" pageSize="50" 
			totalElements="1" elementCount="0" totalPages="1"/>
			<ns2:productUsageRules pageNumber="1" pageSize="50" 
			totalElements="0" elementCount="0" totalPages="0"/>
			</ns2:recurringProductPrice>
			<ns2:oneTimeProductPrice chargeDuringRenewal="false" fromDate="2012-11-27T00:00:00.000-06:00" thruDate="2013-07-01T00:00:00.000-05:00" priceOverride="false" type="OneTime" paymentOnPurchaseRequired="false" currencyType="USD" eid="4241" queryScope="SHALLOW">
			<ns2:priceRanges pageNumber="1" pageSize="50" 
			totalElements="3" elementCount="0" totalPages="1"/>
			<ns2:productUsageRules pageNumber="1" pageSize="50" 
			totalElements="0" elementCount="0" totalPages="0"/>
			</ns2:oneTimeProductPrice>
			<ns2:oneTimeProductPrice chargeDuringRenewal="false" fromDate="2013-07-01T00:00:00.000-05:00" priceOverride="false" type="OneTime" paymentOnPurchaseRequired="false" currencyType="USD" eid="5797" queryScope="SHALLOW">
			<ns2:priceRanges pageNumber="1" pageSize="50" 
			totalElements="3" elementCount="0" totalPages="1"/>
			<ns2:productUsageRules pageNumber="1" pageSize="50" 
			totalElements="0" elementCount="0" totalPages="0"/>
			</ns2:oneTimeProductPrice>
		</productPrices>