Palo Alto Networks · Schema

SubscriptionEntitlements

SubscriptionEntitlements schema from Palo Alto Networks SASE Subscription Service API

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
subscription_id string Unique identifier of the subscription.
product_name string Product name.
entitlements array Granular entitlements included in the subscription.
allocations array Current license allocations by child TSG.
View JSON Schema on GitHub

JSON Schema

sase-subscription-api-subscription-entitlements-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SubscriptionEntitlements",
  "description": "SubscriptionEntitlements schema from Palo Alto Networks SASE Subscription Service API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/sase-subscription-api-subscription-entitlements-schema.json",
  "type": "object",
  "properties": {
    "subscription_id": {
      "type": "string",
      "description": "Unique identifier of the subscription."
    },
    "product_name": {
      "type": "string",
      "description": "Product name."
    },
    "entitlements": {
      "type": "array",
      "description": "Granular entitlements included in the subscription.",
      "items": {
        "type": "object",
        "properties": {
          "feature": {
            "type": "string",
            "description": "Feature or capability name."
          },
          "licensed_quantity": {
            "type": "integer",
            "description": "Licensed quantity for this entitlement."
          },
          "allocated_quantity": {
            "type": "integer",
            "description": "Quantity already allocated to child TSGs."
          },
          "available_quantity": {
            "type": "integer",
            "description": "Remaining quantity available for allocation."
          },
          "unit": {
            "type": "string",
            "description": "Unit of measure."
          }
        }
      }
    },
    "allocations": {
      "type": "array",
      "description": "Current license allocations by child TSG.",
      "items": {
        "type": "object",
        "properties": {
          "tsg_id": {
            "type": "string",
            "description": "Child TSG ID receiving this allocation."
          },
          "tsg_name": {
            "type": "string",
            "description": "Display name of the child TSG."
          },
          "allocated_quantity": {
            "type": "integer",
            "description": "Quantity allocated to this TSG."
          },
          "utilized_quantity": {
            "type": "integer",
            "description": "Quantity currently utilized by this TSG."
          }
        }
      }
    }
  }
}