Subscription Throttling Policy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/main/json-schema/wso2-subscription-throttle-policy-schema.json",
  "title": "Subscription Throttling Policy",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wso2-subscription-policy-collection-api-openapi.yml#/components/schemas/SubscriptionThrottlePolicy",
  "allOf": [
    {
      "$ref": "#/$defs/ThrottlePolicy"
    },
    {
      "$ref": "#/$defs/GraphQLQuery"
    },
    {
      "required": [
        "defaultLimit"
      ],
      "type": "object",
      "properties": {
        "defaultLimit": {
          "$ref": "#/$defs/ThrottleLimit"
        },
        "monetization": {
          "$ref": "#/$defs/MonetizationInfo"
        },
        "rateLimitCount": {
          "type": "integer",
          "description": "Burst control request count"
        },
        "rateLimitTimeUnit": {
          "type": "string",
          "description": "Burst control time unit"
        },
        "subscriberCount": {
          "type": "integer",
          "description": "Number of subscriptions allowed"
        },
        "customAttributes": {
          "type": "array",
          "description": "Custom attributes added to the Subscription Throttling Policy\n",
          "items": {
            "$ref": "#/$defs/CustomAttribute"
          }
        },
        "stopOnQuotaReach": {
          "type": "boolean",
          "description": "This indicates the action to be taken when a user goes beyond the allocated quota. If checked, the user's requests will be dropped. If unchecked, the requests will be allowed to pass through.\n",
          "default": false
        },
        "billingPlan": {
          "type": "string",
          "description": "define whether this is Paid or a Free plan. Allowed values are FREE or COMMERCIAL.\n"
        },
        "permissions": {
          "$ref": "#/$defs/SubscriptionThrottlePolicyPermission"
        }
      }
    }
  ],
  "$defs": {
    "AIAPIQuotaLimit": {
      "title": "AI API Quota Limit object",
      "allOf": [
        {
          "$ref": "#/$defs/ThrottleLimitBase"
        },
        {
          "required": [
            "requestCount"
          ],
          "type": "object",
          "properties": {
            "requestCount": {
              "type": "integer",
              "description": "Maximum number of requests allowed",
              "format": "int64"
            },
            "totalTokenCount": {
              "type": "integer",
              "description": "Maximum number of total tokens allowed",
              "format": "int64"
            },
            "promptTokenCount": {
              "type": "integer",
              "description": "Maximum number of prompt tokens allowed",
              "format": "int64"
            },
            "completionTokenCount": {
              "type": "integer",
              "description": "Maximum number of completion tokens allowed",
              "format": "int64"
            }
          }
        }
      ]
    },
    "BandwidthLimit": {
      "title": "Bandwidth Limit object",
      "allOf": [
        {
          "$ref": "#/$defs/ThrottleLimitBase"
        },
        {
          "required": [
            "dataAmount",
            "dataUnit"
          ],
          "type": "object",
          "properties": {
            "dataAmount": {
              "type": "integer",
              "description": "Amount of data allowed to be transfered",
              "format": "int64"
            },
            "dataUnit": {
              "type": "string",
              "description": "Unit of data allowed to be transfered. Allowed values are \"KB\", \"MB\" and \"GB\""
            }
          }
        }
      ]
    },
    "CustomAttribute": {
      "title": "Name-Value pair",
      "required": [
        "name",
        "value"
      ],
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the custom attribute"
        },
        "value": {
          "type": "string",
          "description": "Value of the custom attribute"
        }
      }
    },
    "EventCountLimit": {
      "title": "Event Count Limit object",
      "allOf": [
        {
          "$ref": "#/$defs/ThrottleLimitBase"
        },
        {
          "required": [
            "eventCount"
          ],
          "type": "object",
          "properties": {
            "eventCount": {
              "type": "integer",
              "description": "Maximum number of events allowed",
              "format": "int64"
            }
          }
        }
      ]
    },
    "GraphQLQuery": {
      "title": "GraphQL Query",
      "type": "object",
      "properties": {
        "graphQLMaxComplexity": {
          "type": "integer",
          "description": "Maximum Complexity of the GraphQL query"
        },
        "graphQLMaxDepth": {
          "type": "integer",
          "description": "Maximum Depth of the GraphQL query"
        }
      }
    },
    "MonetizationInfo": {
      "title": "API monetization details object",
      "required": [
        "properties"
      ],
      "type": "object",
      "properties": {
        "monetizationPlan": {
          "type": "string",
          "description": "Flag to indicate the monetization plan",
          "enum": [
            "FIXEDRATE",
            "DYNAMICRATE"
          ]
        },
        "properties": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Map of custom properties related to each monetization plan"
        }
      }
    },
    "RequestCountLimit": {
      "title": "Request Count Limit object",
      "allOf": [
        {
          "$ref": "#/$defs/ThrottleLimitBase"
        },
        {
          "required": [
            "requestCount"
          ],
          "type": "object",
          "properties": {
            "requestCount": {
              "type": "integer",
              "description": "Maximum number of requests allowed",
              "format": "int64"
            }
          }
        }
      ]
    },
    "SubscriptionThrottlePolicyPermission": {
      "title": "SubscriptionThrottlePolicyPermission",
      "required": [
        "permissionType",
        "roles"
      ],
      "type": "object",
      "properties": {
        "permissionType": {
          "type": "string",
          "enum": [
            "ALLOW",
            "DENY"
          ]
        },
        "roles": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "ThrottleLimit": {
      "title": "Throttle Limit",
      "required": [
        "type"
      ],
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Type of the throttling limit. Allowed values are \"REQUESTCOUNTLIMIT\", \"BANDWIDTHLIMIT\", \"EVENTCOUNTLIMIT\"\nand \"AIAPIQUOTALIMIT\".\nPlease see schemas of \"RequestCountLimit\", \"BandwidthLimit\", \"EventCountLimit\" and \"AIAPIQuotaLimit\" \nthrottling limit types in Definitions section.\n",
          "enum": [
            "REQUESTCOUNTLIMIT",
            "BANDWIDTHLIMIT",
            "EVENTCOUNTLIMIT",
            "AIAPIQUOTALIMIT"
          ]
        },
        "requestCount": {
          "$ref": "#/$defs/RequestCountLimit"
        },
        "bandwidth": {
          "$ref": "#/$defs/BandwidthLimit"
        },
        "eventCount": {
          "$ref": "#/$defs/EventCountLimit"
        },
        "aiApiQuota": {
          "$ref": "#/$defs/AIAPIQuotaLimit"
        }
      }
    },
    "ThrottleLimitBase": {
      "title": "Throttle Limit Base",
      "required": [
        "timeUnit",
        "unitTime"
      ],
      "type": "object",
      "properties": {
        "timeUnit": {
          "type": "string",
          "description": "Unit of the time. Allowed values are \"sec\", \"min\", \"hour\", \"day\""
        },
        "unitTime": {
          "type": "integer",
          "description": "Time limit that the throttling limit applies."
        }
      }
    },
    "ThrottlePolicy": {
      "title": "Generic Throttling Policy",
      "required": [
        "policyName"
      ],
      "type": "object",
      "properties": {
        "policyId": {
          "type": "string",
          "description": "Id of policy",
          "readOnly": true
        },
        "policyName": {
          "maxLength": 60,
          "minLength": 1,
          "type": "string",
          "description": "Name of policy"
        },
        "displayName": {
          "type": "string",
          "description": "Display name of the policy",
          "maxLength": 512
        },
        "description": {
          "maxLength": 1024,
          "type": "string",
          "description": "Description of the policy"
        },
        "isDeployed": {
          "type": "boolean",
          "description": "Indicates whether the policy is deployed successfully or not.",
          "default": false
        },
        "type": {
          "type": "string",
          "description": "Indicates the type of throttle policy"
        }
      }
    }
  }
}