Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.32 KB

ecprice.md

File metadata and controls

29 lines (19 loc) · 1.32 KB
description
A way to describe pricing data

ECPrice

If you want to relay pricing data to the server, you instantiate ECPrice. For example, when you purchase a title via ec.purchaseTitle on ECommerceInterface, you're expected to present a price as a parameter.

Constructor

ECPrice expects exactly two parameters for its single constructor: amount, and currency.

var price = new ECPrice(amount, currency);

For example, let's assume you wish to instantiate a price representing 4.99 USD. Both the amount and the currency are strings.

var price = new ECPrice('4.99', 'USD');

Properties

Property Name Discussion
price.amount The amount that this ECPrice object represents, as a string. It is not converted to a numerical type for usage.
price.currency The currency this ECPrice object represents, as a string. There is no defined list of currencies checked against, so any value may be utilized.