UPowr Retail Offer API (1.0.0)
Download OpenAPI specification:Download
Create a new retail offer
Authorizations:
session
Request Body schema: application/jsonrequired
| name required | string <= 40 characters The name of the Retail Offer. |
| tags | Array of strings A list of tags for filtering purposes |
| customerId | string The unique identifier for the customer this Retail Offer is related to. |
required | object (RetailOfferData) This which will contain all charges and their related information (supply, usage, other, export) |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "tags": [
- "string"
], - "customerId": "string",
- "data": {
- "seasons": [
- {
- "open": "string",
- "close": "string",
- "intervals": [
- {
- "label": "string",
- "end_time": "string",
- "start_time": "string",
- "block1_cpkwh": 0,
- "block2_cpkwh": 0,
- "days_of_week": [
- 0
], - "demand_charge_cpkwpd": 0
}
]
}
], - "controlled_load": [
- {
- "class": "string",
- "rate_cpkwh": 0
}
], - "customer_cost_per_billing_period_cents": 0,
- "eic_xref": "string",
- "public_display_name": "string",
- "offer_id": "string",
- "dnsp_code": "string",
- "plan_type": "string",
- "effective_to": "string",
- "retailer_code": "string",
- "effective_from": "string",
- "billing_period_m": 0,
- "blocking_period_m": 0,
- "block1_size_kwh": 0,
- "feed_in_tariff_cpkwh": 0,
- "premium_feed_in_tariff_cpkwh": 0,
- "general_usage_supply_charge_cpday": 0,
- "billing_period_fixed_credits_cents": 0,
- "is_gross_consumption": true,
- "includes_gst": true,
- "gst_percentage": 0,
- "charges": {
- "ancillary_cpkwh": 0,
- "ess_cpkwh": 0,
- "veec_cpkwh": 0,
- "lrec_cpkwh": 0,
- "srec_cpkwh": 0
}, - "percentage_off_default_offer": {
- "minimum": 0,
- "ausgrid": 0,
- "endeavour": 0,
- "energex": 0,
- "essential": 0,
- "sapn": 0
}, - "gov_id": "string"
}
}Response samples
- 201
- 400
- 401
- 500
Content type
application/json
Retail Offer created
{- "id": "ABC123456DE"
}Update an existing retail offer
Authorizations:
session
path Parameters
| offerId required | string The Retail Offer ID |
Request Body schema: application/jsonrequired
Any of
| name required | string <= 40 characters The name of the Retail Offer. |
| tags | Array of strings A list of tags for filtering purposes |
| customerId | string The unique identifier for the customer this Retail Offer is related to. |
object (RetailOfferData) This which will contain all charges and their related information (supply, usage, other, export) |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "tags": [
- "string"
], - "customerId": "string",
- "data": {
- "seasons": [
- {
- "open": "string",
- "close": "string",
- "intervals": [
- {
- "label": "string",
- "end_time": "string",
- "start_time": "string",
- "block1_cpkwh": 0,
- "block2_cpkwh": 0,
- "days_of_week": [
- 0
], - "demand_charge_cpkwpd": 0
}
]
}
], - "controlled_load": [
- {
- "class": "string",
- "rate_cpkwh": 0
}
], - "customer_cost_per_billing_period_cents": 0,
- "eic_xref": "string",
- "public_display_name": "string",
- "offer_id": "string",
- "dnsp_code": "string",
- "plan_type": "string",
- "effective_to": "string",
- "retailer_code": "string",
- "effective_from": "string",
- "billing_period_m": 0,
- "blocking_period_m": 0,
- "block1_size_kwh": 0,
- "feed_in_tariff_cpkwh": 0,
- "premium_feed_in_tariff_cpkwh": 0,
- "general_usage_supply_charge_cpday": 0,
- "billing_period_fixed_credits_cents": 0,
- "is_gross_consumption": true,
- "includes_gst": true,
- "gst_percentage": 0,
- "charges": {
- "ancillary_cpkwh": 0,
- "ess_cpkwh": 0,
- "veec_cpkwh": 0,
- "lrec_cpkwh": 0,
- "srec_cpkwh": 0
}, - "percentage_off_default_offer": {
- "minimum": 0,
- "ausgrid": 0,
- "endeavour": 0,
- "energex": 0,
- "essential": 0,
- "sapn": 0
}, - "gov_id": "string"
}
}Response samples
- 200
- 400
- 401
- 500
Content type
application/json
Retail Offer actioned
{- "ok": true
}