Fields

bandCategory : String! required

Category the rate applies to, eg. standing charge or consumption charge.
discountExcludingTax : Decimal! required

Discount per unit in cents, excluding tax.
discountIncludingTax : Decimal! required

Discount per unit in cents, including tax.
displayLabel : String! required

Even more readable label for the rate.
formattedDiscountExcludingTax : String! required

Formatted dollar amount of the discount, excluding tax.
formattedDiscountIncludingTax : String! required

Formatted dollar amount of the discount, including tax.
formattedRateExcludingTax : String! required

Formatted dollar amount, excluding tax.
formattedRateExcludingTaxIncludingDiscount : String! required

Formatted dollar amount including discount, excluding tax.
formattedRateIncludingTax : String! required

Formatted dollar amount, including tax.
formattedRateIncludingTaxIncludingDiscount : String! required

Formatted dollar amount including discount, including tax.
hasDiscount : Boolean! required

Whether or not the rate includes a discount component.
label : String! required

Readable label for the rate.
metadata : JSONString

Rate metadata from the product catalog.
rateExcludingTax : Decimal! required

Raw price per unit in cents, excluding tax.
rateExcludingTaxIncludingDiscount : Decimal! required

Discounted price per unit in cents, excluding tax.
rateIncludingTax : Decimal! required

Raw price per unit in cents, including tax.
rateIncludingTaxIncludingDiscount : Decimal! required

Discounted price per unit in cents, including tax.
rateSpecificationCode : String

Product catalog rate specification code that uniquely identifies the rate type, e.g. CAPACITY_CHARGE vs CAPACITY_CHARGE_KW. Distinct from bandCategory, which can group multiple rate types (e.g. ADDITIONAL_CREDIT).
touBucketName : String! required

Time of use bucket the rate applies to.
unitType : String! required

Unit type for the rate, eg. daily rate vs kWh consumed.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "bandCategory": "spring-painting-glass-enough-remain", "discountExcludingTax": "1.0", "discountIncludingTax": "1.0", "displayLabel": "them-name-charge-strategy-machine", "formattedDiscountExcludingTax": "level-animal-member-seat-institution", "formattedDiscountIncludingTax": "great-prevent-after-medical-watch", "formattedRateExcludingTax": "real-I-read-painting-decade", "formattedRateExcludingTaxIncludingDiscount": "debate-though-especially-avoid-store", "formattedRateIncludingTax": "model-happy-memory-say-collection", "formattedRateIncludingTaxIncludingDiscount": "president-require-spring-especially-participant", "hasDiscount": true, "label": "discussion-night-common-smile-term", "metadata": {"key": "value"}, "rateExcludingTax": "1.0", "rateExcludingTaxIncludingDiscount": "1.0", "rateIncludingTax": "1.0", "rateIncludingTaxIncludingDiscount": "1.0", "rateSpecificationCode": "form-develop-white-religious-such", "touBucketName": "air-tonight-performance-first-it", "unitType": "seven-size-couple-personal-close" }