Fields

category : String

The category of the rate, e.g. 'CONSUMPTION_CHARGE' or 'STANDING_CHARGE'.
currency : String

The currency the rate is priced in.
isSalesTax : Boolean! required

Whether the rate represents a sales tax.
name : String! required

The display name of the rate.
overridePrice : Decimal

Override price for the applicable rate.
pricePerUnit : Decimal! required

Price per unit.
rateId : Int

Technical identifier of the applicable rate.
sourceSystem : String! required

The system the rate was sourced from.
unit : String! required

Unit of the applicable rate.
unitDisplay : String! required

A human-readable display of the unit, e.g. 'p/kWh'.
validityPeriod : ApplicableRateValidityPeriodType! required

The period during which the rate is valid.
variantProfile : VariantProfile! required

The variant profile for the applicable rate.
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

{ "category": "seem-adult-bed-bed-above", "currency": "especially-evening-sit-player-system", "isSalesTax": true, "name": "shoulder-home-sound-low-certain", "overridePrice": "1.0", "pricePerUnit": "1.0", "rateId": 29899162, "sourceSystem": "adult-common-employee-teach-operation", "unit": "expert-young-election-message-science", "unitDisplay": "reality-item-since-magazine-resource", "validityPeriod": ApplicableRateValidityPeriodType, "variantProfile": VariantProfile }