AT&T · Schema

Product

Product schema from AT&T API

5GBroadbandCAMARAConnectivityDevice StatusEdge ComputingEnterpriseFortune 100MessagingMobileNetworkNetwork APIsSIM SwapSpeechTelecommunicationsWirelessWireline

Properties

Name Type Description
id string Unique product/subscriber identifier
href string
status string Product status
productOffering object
View JSON Schema on GitHub

JSON Schema

mvnx-api-product-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/att/refs/heads/main/json-schema/mvnx-api-product-schema.json",
  "title": "Product",
  "description": "Product schema from AT&T API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique product/subscriber identifier",
      "example": "sub-a1b2c3d4"
    },
    "href": {
      "type": "string",
      "format": "uri",
      "example": "https://devex-web.att.com/product/sub-a1b2c3d4"
    },
    "status": {
      "type": "string",
      "description": "Product status",
      "enum": [
        "active",
        "suspended",
        "terminated"
      ],
      "example": "active"
    },
    "productOffering": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "offer-unlimited-basic"
        },
        "name": {
          "type": "string",
          "example": "Unlimited Basic Plan"
        }
      }
    }
  }
}