WSO2 · JSON Structure

Publisher Api Subscription Structure

Subscription schema from WSO2 API Manager

Type: object Properties: 4 Required: 4
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Subscription is a JSON Structure definition published by WSO2, describing 4 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

subscriptionId applicationInfo throttlingPolicy subscriptionStatus

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/wso2/refs/heads/main/json-structure/publisher-api-subscription-structure.json",
  "name": "Subscription",
  "description": "Subscription schema from WSO2 API Manager",
  "required": [
    "applicationInfo",
    "subscriptionId",
    "subscriptionStatus",
    "throttlingPolicy"
  ],
  "type": "object",
  "properties": {
    "subscriptionId": {
      "type": "string",
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "applicationInfo": {
      "$ref": "#/components/schemas/ApplicationInfo"
    },
    "throttlingPolicy": {
      "type": "string",
      "example": "Unlimited"
    },
    "subscriptionStatus": {
      "type": "string",
      "example": "BLOCKED",
      "enum": [
        "BLOCKED",
        "PROD_ONLY_BLOCKED",
        "UNBLOCKED",
        "ON_HOLD",
        "REJECTED",
        "TIER_UPDATE_PENDING",
        "DELETE_PENDING"
      ]
    }
  }
}