Billing Payload Definition

NBI delivers information to northbound systems by generating a payload of information whenever an add/delete subscriber or service change is detected.

JSON Schema (Payload) for ADD / MOD Subscriber

This section provides a sample payload, representing the default payload schema. This sample can be customized to meet the specific billing requirements captured during the design stage, with regard to feeding billing information to the northbound system.

Note

Refer to the appendix for a full definition of the billing payload format (sample schema).

{
    "$schema":"http://json-schema.org/release-01/schema#",
     "title":"Payload Add/Change message v0.12",
    "type":"object",
    "required":["Order","User"],
    "properties":{
        "Order":{
            "type":"object",
                "required":[
                    "CallbackURL",  "MessageID",
                    "Timestamp",    "CallingSystem",
                    "UserID",            "Operation",
                    "Customer",       "Location",
                    "HardwareGroup"
                ],
        },
        "User":{
            "type":"array",
            "minItems":1,
            "items":{
                "required":[
                    "Username",
                    "ContactPhone",
                    "ExtensionNumber",
                    "MobilePhone",
                    "FirstName",
                    "LastName",
                    "Email"
                ],
            },
            "Lines": "type":"array", "items": {"required":["ExtensionNumber",
                     "ShortNumber", DDI"]},
            "Devices": "type":"array", "items": { "required":["Model",
                     "Name"]},
            "Mobility Profile": "type":"array", "items":
                     {"required":["Model", "Name"]},
        }
   }
}