{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "id": "http://api.sprint.com/schema/subscriptions#",
    "title": "Subscriptions Schema",
    "type": "object",
    "properties": {
        "subscriptions": {
            "items": {
                "$ref": "#/definitions/subscription"
            },
            "type": "array",
            "uniqueItems": true
        }
    },
    "additionalProperties": true,
    "definitions": {
        "subscription": {
            "allOf": [
                {
                    "$ref": "#/definitions/identifiable"
                },
                {
                    "properties": {
                        "accountId": {
                            "type": "string",
                            "maxLength": 9,
                            "description": "The unique Billing Account Number (BAN) used to accrue charges for invoicing."
                        },
                        "additionalImsi": {
                            "type": "string",
                            "maxLength": 16,
                            "description": "For dual Phones, to be populated for CDMA subscriptions."
                        },
                        "communication": {
                            "$ref": "#/definitions/communication",
                            "description": "TODO: Need a description here"
                        },
                        "created": {
                            "type": "string",
                            "format": "date",
                            "description": "Need a description here"
                        },
                        "csaId": {
                            "type": "string",
                            "maxLength": 10,
                            "description": "Communication Service Area (CSA) Identifier uniquely identifies an instance of a geographic area (CSA) served by a communication service provider, which can be broken down into regional, metropolitan, district and smaller sections called leaves."
                        },
                        "csaInAffiliatedTerritory": {
                            "type": "boolean",
                            "description": "TODO: Need a description here"
                        },
                        "device": {
                            "$ref": "#/definitions/deviceInstance",
                            "description": "A specific physical instance of a device that has been purchased."
                        },
                        "deviceAddons": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/deviceAddon"
                            },
                            "description": "TODO: Need a description here"
                        },
                        "deviceContract": {
                            "$ref": "#/definitions/deviceContract",
                            "description": "Describes the customers contract for a device."
                        },
                        "definitions": {
                            "deviceInstance": {
                                "allOf": [
                                    {
                                        "$ref": "#/definitions/device"
                                    },
                                    {
                                        "properties": {
                                            "attributeCode": {
                                                "type": "string",
                                                "enum": [
                                                    "AIRAVE_PHASE_1_FEMTO_ONLY",
                                                    "AIRAVE_PHASE_2_FEMTO_ONLY",
                                                    "AIRAVE_PHASE_2_FEMTO_ATA",
                                                    "4G_SINGLE_MODE"
                                                ],
                                                "description": "The type of Airave service the subscription has."
                                            },
                                            "hpptt": {
                                                "$ref": "#/definitions/highPerformancePushToTalk",
                                                "description": "High Performance Push-To-Talk (HPPTT) information."
                                            },
                                            "dateActivated": {
                                                "type": "string",
                                                "format": "date",
                                                "description": "TODO: Need a description here"
                                            },
                                            "lastModified": {
                                                "type": "string",
                                                "format": "date",
                                                "description": "TODO: Need a description here"
                                            },
                                            "created": {
                                                "type": "string",
                                                "format": "date",
                                                "description": "TODO: Need a description here"
                                            },
                                            "status": {
                                                "type": "string",
                                                "enum": [
                                                    "NEVER_ACTIVATED",
                                                    "PREVIOUSLY_ACTIVATED",
                                                    "ACTIVATED"
                                                ],
                                                "description": "TODO: Need a description here"
                                            }
                                        }
                                    }
                                ]
                            },
                            "deviceAddon": {
                                "$ref": "#/definitions/addon"
                            },
                            "deviceContract": {
                                "$ref": "#/definitions/addon"
                            }
                        },
                        "imsi": {
                            "type": "string",
                            "maxLength": 16,
                            "description": "The International Mobile Subscription Identify, a unique number associated with all GSM and UMTS network mobile phone users. It is stored in the SIM inside the phone and is sent by the phone to the network.  For CDMA subscription this field contains the value of MSID."
                        },
                        "hca": {
                            "type": "string",
                            "maxLength": 30,
                            "description": "Home Calling Area (HSA) is where all of the calls made on a wireless device are free."
                        },
                        "ip": {
                            "$ref": "#/definitions/internetProtocol",
                            "description": "Internet protocol (IP) information."
                        },
                        "languageCode": {
                            "type": "string",
                            "maxLength": 3,
                            "description": "The language preference."
                        },
                        "lastModified": {
                            "type": "string",
                            "format": "date",
                            "description": "(TODO: After we define the type data, we need to update above type field to date) Need a description here"
                        },
                        "mdn": {
                            "$ref": "#/definitions/mobileDirectory",
                            "description": "Mobile Directory Number (MDN) information."
                        },
                        "nai": {
                            "$ref": "#/definitions/networkAccess",
                            "description": "Network Access Identifier (NAI) information."
                        },
                        "nickname": {
                            "type": "string",
                            "description": "TODO: Need a description here"
                        },
                        "npaSplit": {
                            "type": "string",
                            "description": "The new Numbering Plan Area (NPA) after a split had happened."
                        },
                        "pinCode": {
                            "type": "string",
                            "description": "TODO: Need a description here"
                        },
                        "portIn": {
                            "$ref": "#/definitions/portIn",
                            "description": "Need a description here"
                        },
                        "portOutGuard": {
                            "type": "boolean",
                            "description": "Also known as a port out freeze."
                        },
                        "portOutPending": {
                            "type": "boolean",
                            "description": "TODO: Need a description here"
                        },
                        "pricePlanCode": {
                            "type": "string",
                            "maxLength": 9,
                            "description": "Describes an individual that is using a device and service."
                        },
                        "subscriptionGroupIds": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            },
                            "description": "TODO: Need a description here"
                        },
                        "ufmi": {
                            "$ref": "#/definitions/urbanFleetMember",
                            "description": "Urban Fleet Member Id (UFMI) information.  Used to identify the Direct Connect Subscription in the iDen network."
                        },
                        "ufp": {
                            "$ref": "#/definitions/upgradeFrequencyProgram",
                            "description": "Upgrade Frequency Program (UFP) information."
                        },
                        "unlockCode": {
                            "type": "string",
                            "description": "TODO: Need a description here"
                        },
                        "upgradeEligible": {
                            "type": "string",
                            "format": "date",
                            "description": "Need a description here"
                        }
                    },
                    "required": [
                        "accountId"
                    ]
                }
            ],
            "definitions": {
                "identifiable": {
                    "$schema": "http://json-schema.org/draft-04/schema#",
                    "id": "http://api.sprint.com/schema/identifiable#",
                    "title": "Identifiable Schema",
                    "type": "object",
                    "properties": {
                        "id": {
                            "type": "string",
                            "description": "READ ONLY. The id of the resource."
                        }
                    },
                    "required": [
                        "id"
                    ],
                    "additionalProperties": true
                }
            }
        }
    }
}