SubscriptionList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/axway/main/json-schema/axway-subscription-list-schema.json",
  "title": "SubscriptionList",
  "description": "A list of Subscription objects.",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/axway-subscription-api-openapi.yml#/components/schemas/SubscriptionList",
  "type": "array",
  "items": {
    "$ref": "#/$defs/Subscription"
  },
  "$defs": {
    "Subscription": {
      "type": "object",
      "description": "Organization entitlements",
      "required": [
        "id",
        "product",
        "plan",
        "entitlements"
      ],
      "additionalProperties": false,
      "properties": {
        "end_date": {
          "type": "string",
          "format": "date-time",
          "description": "When the subscription is active to."
        },
        "entitlements": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "key",
              "value"
            ],
            "properties": {
              "key": {
                "type": "string",
                "description": "Entitlement key."
              },
              "value": {
                "oneOf": [
                  {
                    "type": "boolean",
                    "description": "Boolean entitlement, granting access to a feature of capability."
                  },
                  {
                    "type": "integer",
                    "description": "Integer entitlement value, granting quota of allow transactions or requests per month.",
                    "maximum": 9999999999999
                  },
                  {
                    "type": "number",
                    "description": "Numeric entitlement value, granting allow volumes of network throughput or storage.",
                    "maximum": 9999999999999
                  },
                  {
                    "type": "array",
                    "description": "Set entitlement, listing provisioned service or environment availability.",
                    "items": {
                      "type": "string",
                      "description": "Service or environment key."
                    }
                  }
                ]
              }
            }
          }
        },
        "governance": {
          "type": "string",
          "description": "Governance model for the subscription.",
          "enum": [
            "SaaS",
            "Customer Managed",
            "Axway Managed"
          ]
        },
        "id": {
          "type": "string",
          "description": "Identifier for the subscription."
        },
        "opportunity_id": {
          "type": "number",
          "description": "Opportunity ID associated with the subscription.",
          "minimum": 10000,
          "maximum": 999999
        },
        "plan": {
          "type": "string",
          "description": "Which plan the subscription is for."
        },
        "product": {
          "type": "string",
          "description": "Name to identify the product, e.g. APIM, B2Bi."
        },
        "product_name": {
          "type": "string",
          "description": "Official product name.",
          "readOnly": true
        },
        "source": {
          "type": "string",
          "description": "Source of this subscription.",
          "enum": [
            "API",
            "UI",
            "Platform",
            "Billing"
          ]
        },
        "start_date": {
          "type": "string",
          "format": "date-time",
          "description": "When the subscription is active from."
        },
        "tier": {
          "type": "string",
          "description": "Whether the subscription is a trial or paid for.",
          "enum": [
            "paid",
            "trial",
            "free"
          ]
        }
      }
    }
  }
}