Definitions

Generation One NTD: An NTD provided with the initial rollout of the nbn network. Will have an NTD type (ntdType) and NTD version (ntdVersion) as listed in the below table.

Table 1. Generation One NTDs
Access Technology	NTD Type (ntdType)	NTD Version (ntdVersion)	Total Max Bandwidth (Mbs) Down / Up
FTTP	INTERNAL	V1	1300 / 900
FTTP	EXTERNAL	V1	1300 / 900
FTTP	SPECIAL	V2	1300 / 900
HFC	INTERNAL	V1	N/A

Generation Two NTD: An NTD provided to support plans with a download speed > 1000 MBit/s. Will have an NTD type (ntdType) and NTD version (ntdVersion) as listed in the below table.

Table 2. Generation Two NTDs
Access Technology	NTD Type (ntdType)	NTD Version (ntdVersion)	Total Max Bandwidth (Mbs) Down / Up
FTTP	1_PORT	V3	2200 / 1100
FTTP	4_PORT	V4	2200 / 1100
HFC	NTD_2.5	V2	N/A

Replacement NTD: A NTD you can replace the existing NTD with. A replacement NTD is currently only an option if the existing NTD is a 1_PORT V3, its port is used, and the customer wants to order a second service. Currently, the only replacement NTD option is a 4_PORT V4.

Table 3. Replacement NTDs
Access Technology	NTD Type (ntdType)	NTD Version (ntdVersion)	Total Max Bandwidth (Mbs) Down / Up
FTTP	4_PORT	V4	2200 / 1100

Introduction

In September 2025, the NBN are introduced plans with download speeds > 1000 MBit/s for the FTTP and HFC access technology types. If the location has a generation one NTD, this means the NTD will need to be replaced with a generation two NTD.

Two-Step Process

You cannot order a plan with a download speed > 1000 MBit/s on a generation one NTD. To order a plan with a download speed > 1000 MBit/s you must follow a two-step process as follows:

Order any plan with a download speed <= 1000 MBit/s.
Perform a plan Change to the plan with a download speed > 1000 MBit/s.

First or Additional NTD

If there is currently no NTD at the location, or you are ordering an additional NTD, depending on the plan type (planType) you may have the option to select the NTD you want. At the moment this applies to the FTTP access technology where the plan type is Residential. In this case you will have the choice between a 1 port NTD or a 4 port NTD. You will be charged if you select the 4 port NTD. If the plan has a plan type of Business you will be offered only the 4 port NTD and you will not be charged for it. For HFC the only choice is the 2.5 NTD, and you will not be charged for it.

Service Qualification Enhancements

To show what plans are offered and what NTD’s can be chosen, the SQ has had the following fields added to it for the FTTP and HFC access technology types:

Field Description

Field	Description
`generationTwoNtds`	An array of generation two NTD details and the cost (if any) associated with choosing that NTD. For FTTP and HFC, if you need a new NTD when ordering, pass in `generationTwoNtds[].name` as the `ntdOption` value. See Order Enhancements.
`replacementNtds`	Only populated on FTTP SQ’s where the NTD is a 1_PORT V3 and the port is used, empty in all other cases. Only populated if infrastructures[].replacementNtdPlans is not empty. An array of generation two NTD details and the cost (if any) associated with choosing that NTD when you order an additional service requiring the replacement of the current NTD. When ordering pass in `replacementNtds[].name` as the `ntdOption` value. See Order Enhancements.
`firstOrAdditionalNtdPlans`	An array of the plans and NTD options available if this will be the first or an additional NTD at the location. The `ntdOptions` array contains a reference to the NTD(s) described in `generationTwoNtds` array.
`generationOneNtdPlans`	An array of the plans available for a generation one NTD. Plans with a download speed > 1000 MBit/s are excluded from the plans available at the location. The `ntdOptions` array will be empty as plans requiring a generation two NTD have been excluded.
`generationTwoNtdPlans`	An array of the plans available for a generation two NTD. There are currently no restrictions on what plans can be ordered on a generation two NTD. The `ntdOptions` array will be empty as generation two NTDs support all plans.
`infrastructures[].plan`	A reference to either `generationOneNtdPlans` or `generationTwoNtdPlans`, depending on which generation the NTD belongs to.
`infrastructures[].remainingDownstreamBandwidth`	Only set on FTTP SQ’s, null for all other access technology types. The amount of available downstream (download) bandwidth that is not currently allocated on the NTD. This can be used to determine if the customer should order an additional NTD.
`infrastructures[].remainingUpstreamBandwidth`	Only set on FTTP SQ’s, null for all other access technology types. The amount of available upstream (upload) bandwidth that is not currently allocated on the NTD.
`infrastructures[].replacementNtdPlans`	Only populated on FTTP SQ’s where the NTD is a 1_PORT V3 and the port is used, empty in all other cases. Contains plans for an additional service where the 1_PORT V3 will be replaced with a 4_PORT V4. Any plans that can fit on another NTD at the location are excluded (you must order those plans on an exiting NTD). Any plans that cannot fit on the replacing 4_PORT V4 are excluded (you must order an additional NTD).
`infrastructures[].replacementNtdInstallationOptions`	Only populated on FTTP SQ’s where the NTD is a 1_PORT V3 and the port is used, empty in all other cases. Only populated if infrastructures[].replacementNtdPlans is not empty. The install options if you order an additional service requiring the replacement of the current NTD. When ordering pass in `replacementNtdInstallationOptions[].option` as the ntdInstallation` value. See Order Enhancements.

generationTwoNtds

An array of generation two NTD details and the cost (if any) associated with choosing that NTD. For FTTP and HFC, if you need a new NTD when ordering, pass in generationTwoNtds[].name as the ntdOption value. See Order Enhancements.

replacementNtds

Only populated on FTTP SQ’s where the NTD is a 1_PORT V3 and the port is used, empty in all other cases. Only populated if infrastructures[].replacementNtdPlans is not empty. An array of generation two NTD details and the cost (if any) associated with choosing that NTD when you order an additional service requiring the replacement of the current NTD. When ordering pass in replacementNtds[].name as the ntdOption value. See Order Enhancements.

firstOrAdditionalNtdPlans

An array of the plans and NTD options available if this will be the first or an additional NTD at the location. The ntdOptions array contains a reference to the NTD(s) described in generationTwoNtds array.

generationOneNtdPlans

An array of the plans available for a generation one NTD. Plans with a download speed > 1000 MBit/s are excluded from the plans available at the location. The ntdOptions array will be empty as plans requiring a generation two NTD have been excluded.

generationTwoNtdPlans

An array of the plans available for a generation two NTD. There are currently no restrictions on what plans can be ordered on a generation two NTD. The ntdOptions array will be empty as generation two NTDs support all plans.

infrastructures[].plan

A reference to either generationOneNtdPlans or generationTwoNtdPlans, depending on which generation the NTD belongs to.

infrastructures[].remainingDownstreamBandwidth

Only set on FTTP SQ’s, null for all other access technology types. The amount of available downstream (download) bandwidth that is not currently allocated on the NTD. This can be used to determine if the customer should order an additional NTD.

infrastructures[].remainingUpstreamBandwidth

Only set on FTTP SQ’s, null for all other access technology types. The amount of available upstream (upload) bandwidth that is not currently allocated on the NTD.

infrastructures[].replacementNtdPlans

Only populated on FTTP SQ’s where the NTD is a 1_PORT V3 and the port is used, empty in all other cases. Contains plans for an additional service where the 1_PORT V3 will be replaced with a 4_PORT V4. Any plans that can fit on another NTD at the location are excluded (you must order those plans on an exiting NTD). Any plans that cannot fit on the replacing 4_PORT V4 are excluded (you must order an additional NTD).

infrastructures[].replacementNtdInstallationOptions

Only populated on FTTP SQ’s where the NTD is a 1_PORT V3 and the port is used, empty in all other cases. Only populated if infrastructures[].replacementNtdPlans is not empty. The install options if you order an additional service requiring the replacement of the current NTD. When ordering pass in replacementNtdInstallationOptions[].option as the ntdInstallation` value. See Order Enhancements.

Capacity Checking

For an SQ with an FTTP access technology type, you can use the fields infrastructures[].remainingDownstreamBandwidth and infrastructures[].remainingUpstreamBandwidth to determine whether an available plan would exceed the capacity remaining on the NTD and advise the customer to order an additional NTD if needed. Example:

    IF access technology type is FTTP THEN
        IF port is Free THEN
            IF (remainingDownstreamBandwidth - plan's speed down < 0Mbps OR
                remainingUpstreamBandwidth - plan's speed up < 0Mbps) THEN
                    "Not enough capacity on existing NTD to support plan."
                    "Order an additional NTD."
        IF port in Use THEN
            "As the speed of the current service on the port is unknown,"
            "it cannot be determined if the plan would exceed the NTD's remaining capacity."
            "In this scenario, it is suggested the order is placed, and it will fail if capacity is exceeded."

NBN Lead Times on High Speed Plans

Note: If you order a plan with a download speed > 1000 Mbs (i.e. the 2GB ones), there may be significant lead times if the NBN has to upgrade the network.

generationTwoNtds Example

FTTP

Generation two NTDs for access technology FTTP.
4_PORT_RESIDENTIAL comes with a fee of $100.
The "name" field is referenced via ntdOptions[] in the firstOrAdditionalNtdPlans array.

{
  "generationTwoNtds" : [ {
    "name" : "1_PORT",
    "ntdType" : "1_PORT",
    "ntdVersion" : "V3",
    "ntdPlanTypes" : [ "RESIDENTIAL" ],
    "fees" : [ {
      "name" : "NTD_INSTALLATION_FEE",
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "&#36;"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "&#36;"
      }
    } ]
  }, {
    "name" : "4_PORT",
    "ntdType" : "4_PORT",
    "ntdVersion" : "V4",
    "ntdPlanTypes" : [ "BUSINESS" ],
    "fees" : [ {
      "name" : "NTD_INSTALLATION_FEE",
      "oneTimeCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "&#36;"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "&#36;"
      }
    } ]
  }, {
    "name" : "4_PORT_RESIDENTIAL",
    "ntdType" : "4_PORT",
    "ntdVersion" : "V4",
    "ntdPlanTypes" : [ "RESIDENTIAL" ],
    "fees" : [ {
      "name" : "NTD_INSTALLATION_FEE",
      "oneTimeCharge" : {
        "amount" : "100.00",
        "currency" : "AUD",
        "symbol" : "&#36;"
      },
      "monthlyRecurringCharge" : {
        "amount" : "0.00",
        "currency" : "AUD",
        "symbol" : "&#36;"
      }
    } ]
  } ]
}

HFC

Generation two NTDs for access technology HFC.
The "name" field is referenced via ntdOptions[] in the firstOrAdditionalNtdPlans array.

{
   "generationTwoNtds":[
      {
         "name":"NTD_2.5",
         "ntdType":"NTD_2.5",
         "ntdVersion":"V2",
         "ntdPlanTypes":[
            "RESIDENTIAL",
            "BUSINESS"
         ],
         "fees":[
            {
               "name":"NTD_INSTALLATION_FEE",
               "oneTimeCharge":{
                  "amount":"0.00",
                  "currency":"AUD",
                  "symbol":"&#36;"
               },
               "monthlyRecurringCharge":{
                  "amount":"0.00",
                  "currency":"AUD",
                  "symbol":"&#36;"
               }
            }
         ]
      }
   ]
}

firstOrAdditionalNtdPlans Example

Plans available for the first NTD or an additional NTD at the location.
ntdOptions[] is populated with the NTD choices for the plan. References generationTwoNtds[].name.

FTTP

{
   "firstOrAdditionalNtdPlans":[
      {
         "name":"Home Fast 25/5",
         "type":"RESIDENTIAL",
         "speedDown":25,
         "speedUp":5,
          "ntdOptions":[
            "1_PORT",
            "4_PORT_RESIDENTIAL"
         ]
      },
      {
         "name":"Home Hyperfast 2000/500",
         "type":"BUSINESS",
         "speedDown":250,
         "speedUp":100,
         "ntdOptions":[
            "4_PORT"
         ]
      }
  ]
}

HFC

{
   "firstOrAdditionalNtdPlans":[
      {
         "name":"Home Fast 25/5",
         "type":"RESIDENTIAL",
         "speedDown":25,
         "speedUp":5,
          "ntdOptions":[
            "NTD_2.5"
         ]
      },
      {
         "name":"Home Hyperfast 2000/500",
         "type":"BUSINESS",
         "speedDown":250,
         "speedUp":100,
         "ntdOptions":[
            "NTD_2.5"
         ]
      }
  ]
}

generationOneNtdPlans Example

Plans available for a generation one NTD.
Only populated if there is a generation one NTD at the location.
Plans with a download speed > 1000 MBit/s are excluded.
ntdOptions[] is empty as plans requiring a generation two NTD have been excluded.
To order plans with a download speed > 1000 MBit/s follow the two-step process.

{
   "generationOneNtdPlans":[
      {
         "name":"Home Fast 25/5",
         "type":"RESIDENTIAL",
         "speedDown":25,
         "speedUp":5,
         "ntdOptions":[

         ]
      }
  ]
}

generationTwoNtdPlans Example

Plans available for a generation two NTD.
Only populated if there is a generation two NTD at the location.
ntdOptions[] is empty as generation two NTDs support all plans.

{
   "generationTwoNtdPlans":[
      {
         "name":"Home Fast 25/5",
         "type":"RESIDENTIAL",
         "speedDown":25,
         "speedUp":5,
          "ntdOptions":[
         ]
      },
      {
         "name":"Home Hyperfast 2000/500",
         "type":"BUSINESS",
         "speedDown":250,
         "speedUp":100,
         "ntdOptions":[
         ]
      }
  ]
}

infrastructure Example

plans references generationOneNtdPlans or generationTwoNtdPlans depending on the generation of the NTD

{
     "infrastructures":[
        {
          ...
          "ntdType":"Internal",
          "ntdVersion":"V1",
          "plans": "generationOneNtdPlans",
          ...
        }
    ]
}

replacementNtdPlans, replacementNtdPlans, replacementNtdInstallationOptions Example

infrastructures[].replacementNtdPlans[].ntdOptions references replacementNtdPlans[].name

    "replacementNtds": [
        {
            "name": "4_PORT_REPLACEMENT",
            "ntdType": "4_PORT",
            "ntdVersion": "V4",
            "ntdPlanTypes": [
                "RESIDENTIAL",
                "BUSINESS"
            ],
            "fees": []
        }
    ],
    ...
    "infrastructures":[
        {
          "infrastructureId":"NTD151638001427",
          "ntdType":"1_PORT",
          "ntdVersion":"V3",
          ...
          "ntdPorts":[
            {
               "portId":"1",
               "portName":"1-UNI-D1",
               "uniType":"UNI-D",
               "status":"Used",
               ...
            }
          ],
          ...
          "replacementNtdPlans": [
            {
               "name":"Home Fast 100/20",
               "type":"RESIDENTIAL",
               "speedDown":100,
               "speedUp":20,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            },
            {
               "name":"Home Superfast 250/25",
               "type":"RESIDENTIAL",
               "speedDown":250,
               "speedUp":25,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            },
            {
               "name":"Home Ultrafast 1000/50",
               "type":"RESIDENTIAL",
               "speedDown":1000,
               "speedUp":50,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            }
         ],
         "replacementNtdInstallationOptions":[
            {
               "option":"nbn-tech",
               "recommended":true,
               "fees":[

               ],
               "hardwareShortfall":true
            }
         ]

replacementNtds, replacementNtdPlans, replacementNtdInstallationOptions Example

infrastructures[].replacementNtdPlans[].ntdOptions references replacementNtdPlans[].name

    "replacementNtds": [
        {
            "name": "4_PORT_REPLACEMENT",
            "ntdType": "4_PORT",
            "ntdVersion": "V4",
            "ntdPlanTypes": [
                "RESIDENTIAL",
                "BUSINESS"
            ],
            "fees": []
        }
    ],
    ...
    "infrastructures":[
        {
          "infrastructureId":"NTD151638001427",
          "ntdType":"1_PORT",
          "ntdVersion":"V3",
          ...
          "ntdPorts":[
            {
               "portId":"1",
               "portName":"1-UNI-D1",
               "uniType":"UNI-D",
               "status":"Used",
               ...
            }
          ],
          ...
          "replacementNtdPlans": [
            {
               "name":"Home Fast 100/20",
               "type":"RESIDENTIAL",
               "speedDown":100,
               "speedUp":20,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            },
            {
               "name":"Home Superfast 250/25",
               "type":"RESIDENTIAL",
               "speedDown":250,
               "speedUp":25,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            },
            {
               "name":"Home Ultrafast 1000/50",
               "type":"RESIDENTIAL",
               "speedDown":1000,
               "speedUp":50,
               "ntdOptions":[
                  "4_PORT_REPLACEMENT"
               ]
            }
         ],
         "replacementNtdInstallationOptions":[
            {
               "option":"nbn-tech",
               "recommended":true,
               "fees":[

               ],
               "hardwareShortfall":true
            }
         ]

Order Enhancements

First or Additional NTD

When you are ordering your first NTD, or an additional NTD, and there is a list of generation two NTDs to choose from, include ntdOption in your order request to specify the NTD you want.

FTTP Example

Use SQ response to determine the list of ntdOptions available for your chosen plan

{
   "firstOrAdditionalNtdPlans":[
      {
         "name":"Home Fast 25/5",
         "type":"RESIDENTIAL",
         "speedDown":25,
         "speedUp":5,
          "ntdOptions":[
            "1_PORT",
            "4_PORT_RESIDENTIAL"
         ]
      }
  ]
}

Specify ntdOption in the create order request payload with the NTD you want

{
   "planName" : "Home Fast 25/5",
   "ntdOption": "4_PORT_RESIDENTIAL",
   ...
}

If ntdOption not provided in the create order request payload, the first option will be selected

1_PORT

HFC Example

Use SQ response to determine the list of ntdOptions available for your chosen plan

{
   "firstOrAdditionalNtdPlans":[
      {
         "name":"Home Fast 25/5",
         "type":"RESIDENTIAL",
         "speedDown":25,
         "speedUp":5,
          "ntdOptions":[
            "NTD_2.5"
         ]
      }
  ]
}

Specify ntdOption in the create order request payload with the NTD you want

{
   "planName" : "Home Fast 25/5",
   "ntdOption": "NTD_2.5",
   ...
}

If ntdOption not provided in the create order request payload, the first option will be selected

NTD_2.5

Replacement NTD

If the customer has a 1_PORT V3 NTD with a service using the port, and they want to order a second service, they will need to replace the existing NTD with a 4_PORT V4. Note only plans in the replacementNtdPlans array can be ordered in this scenario. Only plans whose combined bandwidth with the existing service’s bandwidth that can fit on a 4_PORT V4 are included. Also plans that could fit on another NTD at the location are excluded, as if there is an existing NTD that can support the service it must be selected.

Use SQ response to determine the list of ntdOptions available for your chosen plan (currently the only option will be 4_PORT_REPLACEMENT).

{
         "replacementPlans": [
                {
                    "name": "Home Fast 25/5",
                    "type": "RESIDENTIAL",
                    "speedDown": 25,
                    "speedUp": 5,
                    "ntdOptions": [
                        "4_PORT_REPLACEMENT"
                    ]
                },
                ...
         ]
}

When placing the order, and you want to replace the NTD you must set the following fields in the create order request payload as follows:

{
   "planName" : "Home Fast 25/5",  (additional service)
   "infrastructureId": "NTD151638001599", (must be set)
   "ntdPortId": null, (must be null)
   "ntdOption": "4_PORT_REPLACEMENT", (replacement NTD option)
   "ntdInstallationOption": "nbn-tech", (installation option for replacement NTD)
   ...
}

Service Plan Change Enhancements

To show what plans are offered and what NTD’s can be chosen, the plan change options response had the following added to it for FTTP and HFC access technology types:

For FTTP and HFC

ntdOptions. An array containing available NTD options and any associated costs.
- If the current NTD is Generation One & download speed > 1000 MBit/s, this array will contain one or more entries, each detailing an available upgrade option and its cost (if applicable).
- If the current NTD is Generation Two, this array will be empty, as no upgrade is needed or available.

Important

When selecting plans with speeds greater than 1000 MBit/s, you must include a valid ntdOption along with the contact details in the request payload. These high-speed plans are not compatible with Generation one NTDs, and an upgrade must be specified.

For FTTP Only

requiresAdditionalNtd. A Boolean value indicating whether an additional Network Termination Device (NTD) is required for the plan.
requiresAdditionalNtdReason. If an additional NTD is required, this field explains the reason.

Possible values include:

BANDWIDTH_CAPACITY_EXCEEDED - The current NTD will exceed its remaining bandwidth capacity with the desired plan.
BATTERY_BACKUP - NBN Co has ceased supplying battery backup units for Fibre to the Premises (FTTP), requiring an additional NTD order.

Important

In either of these scenarios, you must order an additional NTD along with the desired plan.

Generation One Example

ntdOptions available for a generation one NTD.

{
    "plans": [
        {
            "sourceType": "NBN",
            "accessTechnology": "FTTP",
            "plan": "Home Fast 25/5",
            "term": "1",
            "downSpeed": {
                "speed": 25,
                "unit": "MBit/s"
            },
            "upSpeed": {
                "speed": 5,
                "unit": "MBit/s"
            },
            "requiresAdditionalNtd": false,
            "requiresAdditionalNtdReason": null,
            "planFee": {
                "attributes": {
                    "plan": "Home Fast 25/5",
                    "term": "1"
                },
                "oneTimeCharge": {
                    "amount": "0.00",
                    "currency": "AUD",
                    "symbol": "&#36;"
                },
                "monthlyRecurringCharge": {
                    "amount": "0.00",
                    "currency": "AUD",
                    "symbol": "&#36;"
                }
            },
            "nfasFee": null,
            "ntdOptions": []
        },
        {
            "sourceType": "NBN",
            "accessTechnology": "FTTP",
            "plan": "Home Hyperfast 2000/200",
            "term": "1",
            "downSpeed": {
                "speed": 2000,
                "unit": "MBit/s"
            },
            "upSpeed": {
                "speed": 200,
                "unit": "MBit/s"
            },
            "requiresAdditionalNtd": true,
            "requiresAdditionalNtdReason": "BANDWIDTH_CAPACITY_EXCEEDED",
            "planFee": {
                "attributes": {
                    "plan": "Home Hyperfast 2000/200",
                    "term": "1"
                },
                "oneTimeCharge": {
                    "amount": "0.00",
                    "currency": "AUD",
                    "symbol": "&#36;"
                },
                "monthlyRecurringCharge": {
                    "amount": "115.00",
                    "currency": "AUD",
                    "symbol": "&#36;"
                }
            },
            "nfasFee": null,
            "ntdOptions": [
                {
                    "option": "1_PORT",
                    "recommended": true,
                    "fee": {
                        "attributes": {
                            "ntd_installation_fee": "1_PORT"
                        },
                        "oneTimeCharge": {
                            "amount": "0.00",
                            "currency": "AUD",
                            "symbol": "&#36;"
                        },
                        "monthlyRecurringCharge": {
                            "amount": "0.00",
                            "currency": "AUD",
                            "symbol": "&#36;"
                        }
                    }
                },
                {
                    "option": "4_PORT_RESIDENTIAL",
                    "recommended": false,
                    "fee": {
                        "attributes": {
                            "ntd_installation_fee": "4_PORT_RESIDENTIAL"
                        },
                        "oneTimeCharge": {
                            "amount": "100.00",
                            "currency": "AUD",
                            "symbol": "&#36;"
                        },
                        "monthlyRecurringCharge": {
                            "amount": "0.00",
                            "currency": "AUD",
                            "symbol": "&#36;"
                        }
                    }
                }
            ]
        }
    ]
}

Generation Two Example

ntdOptions not available for a generation two NTD.

{
    "plans": [
        {
            "sourceType": "NBN",
            "accessTechnology": "FTTP",
            "plan": "Home Fast 25/5",
            "term": "1",
            "downSpeed": {
                "speed": 25,
                "unit": "MBit/s"
            },
            "upSpeed": {
                "speed": 5,
                "unit": "MBit/s"
            },
            "requiresAdditionalNtd": false,
            "requiresAdditionalNtdReason": null,
            "planFee": {
                "attributes": {
                    "plan": "Home Fast 25/5",
                    "term": "1"
                },
                "oneTimeCharge": {
                    "amount": "0.00",
                    "currency": "AUD",
                    "symbol": "&#36;"
                },
                "monthlyRecurringCharge": {
                    "amount": "0.00",
                    "currency": "AUD",
                    "symbol": "&#36;"
                }
            },
            "nfasFee": null,
            "ntdOptions": []
        },
        {
            "sourceType": "NBN",
            "accessTechnology": "FTTP",
            "plan": "Home Hyperfast 2000/200",
            "term": "1",
            "downSpeed": {
                "speed": 2000,
                "unit": "MBit/s"
            },
            "upSpeed": {
                "speed": 200,
                "unit": "MBit/s"
            },
            "requiresAdditionalNtd": true,
            "requiresAdditionalNtdReason": "BANDWIDTH_CAPACITY_EXCEEDED",
            "planFee": {
                "attributes": {
                    "plan": "Home Hyperfast 2000/200",
                    "term": "1"
                },
                "oneTimeCharge": {
                    "amount": "0.00",
                    "currency": "AUD",
                    "symbol": "&#36;"
                },
                "monthlyRecurringCharge": {
                    "amount": "115.00",
                    "currency": "AUD",
                    "symbol": "&#36;"
                }
            },
            "nfasFee": null,
            "ntdOptions": []
        }
    ]
}

Service Plan Change Request with ntdOption Example

{
    "serviceId": 10000,
    "planName": "Home Hyperfast 2000/200",
    "term": 1,
    "restorationSla": "Standard",
    "ntdOption": "4_PORT_RESIDENTIAL",
    "contact_name": "John Smith",
    "contact_phone": "0446789456",
    "contact_email": "john.smith@superloop.com"
}

Webhooks

Appointment webhooks have a new field "appointmentFor" added. This field can have a value of ORDER or SERVICE_PLAN_CHANGE. It indicates if the appointment is due to an order or a service plan change.

At the moment, only the following subset of appointment notifications are implemented for a service plan change. Those notifications can have either of the two values. The rest will always have ORDER as the value.

AppointmentBooked
AppointmentRescheduled
AppointmentCompleted

  ...
  "appointmentFor":"SERVICE_PLAN_CHANGE",
  ...