Pure Storage · Schema

Subscription

Subscription schema from Pure1 Public REST API

StorageData StorageFlash StorageEnterprise StorageCloud StorageObject StorageFile StorageBlock StorageKubernetes StorageInfrastructure
View JSON Schema on GitHub

JSON Schema

pure1-cloud-api-subscription-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Subscription",
  "description": "Subscription schema from Pure1 Public REST API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-subscription-schema.json",
  "allOf": [
    {
      "description": "A built-in resource. Many are singletons predefined by Purity (e.g., support\nsettings). Some correspond to a piece of software, like an app, or hardware,\nlike a controller. Others are created by the system in response to some event\n(e.g., alerts, audit records).\n\nTypically, a user can't create, delete or rename a built-in resource. A few\ncan be created or deleted, but not renamed because the names are meaningful\nto Purity (e.g., VIFs).\n\n",
      "allOf": [
        {
          "$ref": "#/components/schemas/_timeAware"
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "description": "A non-modifiable, globally unique ID chosen by the system.",
              "type": "string",
              "readOnly": true,
              "example": "01c2889a-4124-49ff-8cbd-c33405ede123"
            },
            "name": {
              "description": "A non-modifiable, locally unique name chosen by the system.",
              "type": "string",
              "readOnly": true,
              "example": "example_name"
            }
          }
        }
      ]
    },
    {
      "description": "A Pure1 subscription.\n",
      "type": "object",
      "properties": {
        "customer_name": {
          "description": "The name of the end customer of the asset.",
          "type": "string",
          "readOnly": true,
          "example": "Pure Storage Customer"
        },
        "expiration_date": {
          "description": "Date when the subscription expires.\nRepresented as a timestamp of 00:00 on that date in UTC, in\nmilliseconds since UNIX epoch.\n",
          "type": "integer",
          "format": "int64",
          "example": 1636238104000
        },
        "initial_name": {
          "description": "A non-modifiable, locally unique name that the subscription was started with, never changes.\n",
          "type": "string",
          "readOnly": true,
          "example": "example_name"
        },
        "last_updated_date": {
          "description": "The date of the last amendment to the current subscription.\nRepresented as a timestamp of 00:00 on that date in UTC, in\nmilliseconds since UNIX epoch.\n",
          "type": "integer",
          "format": "int64",
          "example": 1604702243000
        },
        "organization": {
          "description": "This field has been deprecated. Please use `customer_name` instead. The\nPure1 organization for the asset.\n",
          "title": "FixedReference",
          "allOf": [
            {
              "$ref": "#/components/schemas/_fixedReference"
            }
          ]
        },
        "partner_name": {
          "description": "The partner who invoices for the subscription.",
          "type": "string",
          "readOnly": true,
          "example": "Pure Storage Partner"
        },
        "service": {
          "description": "The service type of the subscription. Values include\n`Evergreen//One`,\n`Evergreen//Flex`,\n`FlashStack as a Service`,\n`Storage as a Service`,\n`PaaS (Block Storage Service)`,\n`PaaS (File and Object Storage Service)`,\n`PaaS (Data Protection Service)`,\nand\n`Pure1 Subscription`.\n",
          "type": "string",
          "example": "PaaS (Block Storage Service)"
        },
        "service_details": {
          "description": "Additional details for the given service.\n",
          "oneOf": [
            {
              "$ref": "#/components/schemas/EvergreenForeverAndFoundationDetails"
            },
            {
              "$ref": "#/components/schemas/DefaultDetails"
            }
          ]
        },
        "start_date": {
          "description": "Date when the subscription starts.\nRepresented as a timestamp of 00:00 on that date in UTC, in\nmilliseconds since UNIX epoch.\n",
          "type": "integer",
          "format": "int64",
          "example": 1604702243000
        },
        "status": {
          "description": "Current status of the subscription. Values include `active`,\n`terminated`, `poc-expired`, and `signed`.\n",
          "type": "string",
          "example": "active"
        },
        "subscription_term": {
          "description": "Length of the subscription in months.",
          "type": "integer",
          "example": 24
        }
      }
    }
  ]
}