Palo Alto Networks · JSON Structure

Sase Subscription Api Subscription Entitlements Structure

SubscriptionEntitlements schema from Palo Alto Networks SASE Subscription Service API

Type: object Properties: 4
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

SubscriptionEntitlements is a JSON Structure definition published by Palo Alto Networks, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

subscription_id product_name entitlements allocations

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/sase-subscription-api-subscription-entitlements-structure.json",
  "name": "SubscriptionEntitlements",
  "description": "SubscriptionEntitlements schema from Palo Alto Networks SASE Subscription Service API",
  "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": "int32",
            "description": "Licensed quantity for this entitlement."
          },
          "allocated_quantity": {
            "type": "int32",
            "description": "Quantity already allocated to child TSGs."
          },
          "available_quantity": {
            "type": "int32",
            "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": "int32",
            "description": "Quantity allocated to this TSG."
          },
          "utilized_quantity": {
            "type": "int32",
            "description": "Quantity currently utilized by this TSG."
          }
        }
      }
    }
  }
}