Pure Storage Subscriptions API

Provides information about subscription offerings.

Documentation

Specifications

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-array-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-volume-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-host-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-array-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-volume-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-file-system-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-bucket-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-array-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-file-system-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-bucket-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-array-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-metric-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-alert-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/pure1-cloud-api-array-structure.json

Other Resources

🔗
SDKs
https://pypi.org/project/py-pure-client/
🔗
SDKs
https://github.com/PureStorage-OpenConnect/PureStorage.Pure1
🔗
SDKs
https://github.com/PureStorage-OpenConnect/powershell-toolkit-3
🔗
SDKs
https://github.com/PureStorage-OpenConnect/rest-client
🔗
Integrations
https://github.com/PureStorage-OpenConnect/terraform-provider-flash
🔗
Integrations
https://github.com/PureStorage-OpenConnect/pure-fa-openmetrics-exporter
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flasharray-rest-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-volume-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-array-example.json
🔗
SDKs
https://github.com/PureStorage-OpenConnect/flashblade-powershell
🔗
SDKs
https://github.com/purestorage/purity_fb_python_client
🔗
Integrations
https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter
🔗
Tools
https://github.com/PureStorage-OpenConnect/flashblade-mcp-server
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flashblade-rest-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-file-system-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-bucket-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-pure1-cloud-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/pure1-cloud-api-array-example.json

OpenAPI Specification

pure-storage-subscriptions-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Subscriptions API
  version: '2.52'
  description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos

    or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by

    mapping identities across the NFS and SMB protocols by using LDAP queries.

    '
servers:
- url: /
tags:
- name: Subscriptions
  description: 'Provides information about subscription offerings.

    '
paths:
  /api/2.52/subscriptions:
    get:
      tags:
      - Subscriptions
      summary: Pure Storage List Subscriptions
      description: 'Displays information about subscriptions.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionGetResponse'
  /api/1.5/subscriptions:
    get:
      tags:
      - Subscriptions
      summary: Pure Storage Get Subscriptions
      description: 'Retrieves information about Pure1 subscriptions.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization_2'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token_2'
      - $ref: '#/components/parameters/Filter_2'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Limit_2'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
            X-RateLimit-Remaining-second:
              description: 'The number of requests remaining for the organization in that second.

                '
              schema:
                type: integer
            X-RateLimit-Remaining-minute:
              description: 'The number of requests remaining for the organization in that minute.

                '
              schema:
                type: integer
            X-RateLimit-Limit-second:
              description: The number of requests available per second.
              schema:
                type: integer
            X-RateLimit-Limit-minute:
              description: The number of requests available per minute.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionGetResponse'
        '400':
          $ref: '#/components/responses/Error400'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
  /api/1.5/subscription-licenses:
    get:
      tags:
      - Subscriptions
      summary: Pure Storage Get Subscription Licenses
      description: 'Retrieves information about Pure1 subscription licenses.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization_2'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token_2'
      - $ref: '#/components/parameters/Filter_2'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Limit_2'
      - $ref: '#/components/parameters/Marketplace_partner_reference_ids'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      - $ref: '#/components/parameters/Subscription_ids'
      - $ref: '#/components/parameters/Subscription_names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
            X-RateLimit-Remaining-second:
              description: 'The number of requests remaining for the organization in that second.

                '
              schema:
                type: integer
            X-RateLimit-Remaining-minute:
              description: 'The number of requests remaining for the organization in that minute.

                '
              schema:
                type: integer
            X-RateLimit-Limit-second:
              description: The number of requests available per second.
              schema:
                type: integer
            X-RateLimit-Limit-minute:
              description: The number of requests available per minute.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionLicenseGetResponse'
        '400':
          $ref: '#/components/responses/Error400'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
  /api/1.5/subscription-assets:
    get:
      tags:
      - Subscriptions
      summary: Pure Storage Get Subscription Assets
      description: 'Retrieves information about Pure1 subscription assets.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization_2'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Advanced_space'
      - $ref: '#/components/parameters/Continuation_token_2'
      - $ref: '#/components/parameters/Filter_2'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/License_ids'
      - $ref: '#/components/parameters/License_names'
      - $ref: '#/components/parameters/Limit_2'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Sort_2'
      - $ref: '#/components/parameters/Subscription_ids'
      - $ref: '#/components/parameters/Subscription_names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
            X-RateLimit-Remaining-second:
              description: 'The number of requests remaining for the organization in that second.

                '
              schema:
                type: integer
            X-RateLimit-Remaining-minute:
              description: 'The number of requests remaining for the organization in that minute.

                '
              schema:
                type: integer
            X-RateLimit-Limit-second:
              description: The number of requests available per second.
              schema:
                type: integer
            X-RateLimit-Limit-minute:
              description: The number of requests available per minute.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionAssetGetResponse'
        '400':
          $ref: '#/components/responses/Error400'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
components:
  responses:
    Error404:
      description: NOT FOUND
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

            '
          schema:
            type: object
        X-RateLimit-Remaining-second:
          description: 'The number of requests remaining for the organization in that second.

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error500:
      description: INTERNAL SERVER ERROR
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

            '
          schema:
            type: object
        X-RateLimit-Remaining-second:
          description: 'The number of requests remaining for the organization in that second.

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error403:
      description: FORBIDDEN
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorNoContext'
    Error400:
      description: BAD REQUEST
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

            '
          schema:
            type: object
        X-RateLimit-Remaining-second:
          description: 'The number of requests remaining for the organization in that second.

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error429:
      description: TOO MANY REQUESTS
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

            '
          schema:
            type: object
        X-RateLimit-Remaining-second:
          description: 'The number of requests remaining for the organization in that second.

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorNoContext'
  schemas:
    _license_resource_reference:
      allOf:
      - $ref: '#/components/schemas/_fixedReferenceFqdn'
      - type: object
        properties:
          activation_time:
            description: 'Time when the resource is activated under the license, in

              milliseconds since UNIX epoch.

              '
            type: integer
            format: int64
            example: 1604702243000
          usage:
            description: 'Current usage of the resource under the license.

              '
            title: Current_metric
            allOf:
            - $ref: '#/components/schemas/_current_metric'
    SubscriptionAssetGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/SubscriptionAssetResponse'
    _asset_org:
      type: object
      properties:
        name:
          description: 'This field has been deprecated. Use the `customer_name` field instead.

            The organization name for the asset.

            '
          type: string
          readOnly: true
          example: Pure Storage
      x-readOnly: true
    Error:
      type: object
      properties:
        errors:
          description: The list of errors encountered.
          type: array
          items:
            $ref: '#/components/schemas/_errorErrors'
    _timeAware:
      type: object
      properties:
        _as_of:
          description: The freshness of the data (timestamp in millis since epoch).
          type: integer
          format: int64
          readOnly: true
          example: 1502729489760
    ErrorNoContext:
      type: object
      properties:
        message:
          type: string
          example: Something was wrong
    _errorErrors:
      type: object
      properties:
        context:
          type: string
          example: Error with ...
        message:
          type: string
          example: Something was wrong
    SubscriptionAsset:
      allOf:
      - $ref: '#/components/schemas/_builtInAsOf'
      - type: object
        properties:
          activation_date:
            description: 'The date when the appliance is activated under the license.

              Represented as a timestamp of 00:00 on that date in UTC, in

              milliseconds since UNIX epoch.

              '
            type: integer
            format: int64
            example: 1604702243000
          array:
            description: The specific fields for assets that are arrays.
            title: SubscriptionAssetArray
            allOf:
            - $ref: '#/components/schemas/SubscriptionAssetArray'
          customer_name:
            description: The name of the end customer of the asset.
            type: string
            readOnly: true
            example: Pure Storage Customer
          end_of_life_date:
            description: 'The date when the appliance hardware reach end of life and Pure no longer provide support.

              Represented as a timestamp of 00:00 on that date in UTC, in

              milliseconds since UNIX epoch.

              '
            type: integer
            format: int64
            example: 1636588800000
          install_address:
            description: 'The address where the appliance is installed. This address is also where

              replacement parts will be shipped to.

              '
            title: Asset_address
            allOf:
            - $ref: '#/components/schemas/_asset_address'
          license:
            description: A reference to which license this appliance belongs.
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
          organization:
            description: 'This field has been deprecated. Please use `customer_name` instead. The

              Pure1 organization for the asset.

              '
            title: Asset_org
            allOf:
            - $ref: '#/components/schemas/_asset_org'
          subscription:
            description: A reference to which subscription this appliance belongs.
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
          upgrade_details:
            description: 'The address where the appliance is installed. This address is also where

              replacement parts will be shipped to.

              '
            title: AssetUpgradeDetails
            allOf:
            - $ref: '#/components/schemas/AssetUpgradeDetails'
    SubscriptionLicenseGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/SubscriptionLicenseResponse'
    _current_metric:
      type: object
      properties:
        data:
          description: 'The data value.

            '
          type: number
          example: 123.0
        metric:
          description: 'A reference to the metric this data measures.

            '
          title: FixedReference
          allOf:
          - $ref: '#/components/schemas/_fixedReference'
        unit:
          description: The unit of the metric.
          type: string
          example: B
    AssetUpgradeDetails:
      type: object
      properties:
        action_needed:
          description: 'The action required to obtain the next free upgrade under your `Evergreen//Forever` subscription.

            '
          readOnly: true
          type: string
          example: Your Ever Modern Upgrade has been booked.
        commitment_date:
          description: 'The date until which you need to commit to an `Evergreen//Forever` subscription to be eligible for the next Ever Modern Upgrade.

            '
          readOnly: true
          type: integer
          format: int64
          example: 1604702243000
        upgrade_eligibility_date:
          description: 'The date on which controllers/blades will be eligible for an Ever Modern Upgrade if you renew your `Evergreen//Forever` subscription to the required Forever (FVR) Commitment date.

            '
          readOnly: true
          type: integer
          format: int64
          example: 1604702243000
    SubscriptionLicenseAddOnSla:
      type: object
      properties:
        name:
          type: string
      required:
      - name
    _subscriptionLicensePreRatio:
      description: 'The pre-reduced & encrypted ratio calculated at license level.

        '
      allOf:
      - $ref: '#/components/schemas/_current_metric'
      - type: object
        properties:
          data:
            type: number
            format: float
            example: 3.3
    SubscriptionGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/SubscriptionResponse'
    SubscriptionAssetArray:
      type: object
      properties:
        advanced_space:
          description: 'The physical and effective space information.

            Only visible when the query parameter `advanced_space` is set to `true`.

            '
          title: SubscriptionAssetArrayAdvancedSpace
          allOf:
          - $ref: '#/components/schemas/SubscriptionAssetArrayAdvancedSpace'
        chassis_serial_number:
          description: The chassis serial number of the appliance.
          type: string
          readOnly: true
        model:
          description: The model of the appliance.
          type: string
          readOnly: true
          example: FA-X50R2
        space:
          description: 'Displays size and space consumption information.

            For Evergreen//One and Evergreen//Flex this is the effective space information.

            For Evergreen//Forever and Evergreen//Foundation this is the physical space information.

            '
          title: Asset_space
          allOf:
          - $ref: '#/components/schemas/_asset_space'
        version:
          description: The Purity version of the appliance.
          type: string
          readOnly: true
          example: 5.0.0
    _assetSpaceTotalUsedRatio:
      description: 'The ratio of `total_used` to the `capacity`.

        This represents how full the appliance is.

        '
      allOf:
      - $ref: '#/components/schemas/_current_metric'
      - type: object
        properties:
          data:
            type: number
            format: float
            minimum: 0
            maximum: 1
            example: 0.5
    _base_address:
      type: object
      properties:
        city:
          type: string
          readOnly: true
          example: Mountain View
        country:
          type: string
          readOnly: true
          example: United States
        state:
          description: The state or province.
          type: string
          readOnly: true
          example: CA
    _asset_address:
      allOf:
      - $ref: '#/components/schemas/_base_address'
      - type: object
        properties:
          street_address:
            type: string
            readOnly: true
            example: 2555 Augustine Dr, Santa Clara, CA 95054, United States
    SubscriptionAssetArrayAdvancedSpace:
      type: object
      properties:
        effective:
          description: The effective space information of the appliance.
          title: Asset_space
          allOf:
          - $ref: '#/components/schemas/_asset_space'
        physical:
          description: The physical space information of the appliance.
          title: Asset_space
          allOf:
          - $ref: '#/components/schemas/_asset_space'
    _fixedReferenceFqdn:
      allOf:
      - $ref: '#/components/schemas/_fixedReference'
      - type: object
        properties:
          fqdn:
            description: 'The fully qualified domain name of the appliance when `resource_type` is `arrays`,

              `null` otherwise.

              '
            type: string
            readOnly: true
            example: example_name.dc1.example.com
    _asset_space:
      type: object
      properties:
        capacity:
          description: The usable capacity of the appliance.
          title: Current_metric
          allOf:
          - $ref: '#/components/schemas/_current_metric'
        total_used:
          description: The total space contributed by customer data.
          title: Current_metric
          allOf:
          - $ref: '#/components/schemas/_current_metric'
        total_used_ratio:
          $ref: '#/components/schemas/_assetSpaceTotalUsedRatio'
    Subscription:
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified.

            '
          type: string
        service:
          description: 'The service type of the subscription.

            '
          type: string
          example: Evergreen//One
    _builtInAsOf:
      description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support

        settings). Some correspond to a piece of software, like an app, or hardware,

        like a controller. Others are created by the system in response to some event

        (e.g., alerts, audit records).


        Typically, a user can''t create, delete or rename a built-in resource. A few

        can be created or deleted, but not renamed because the names are meaningful

        to Purity (e.g., VIFs).


        '
      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
    PageInfo_2:
      type: object
      properties:
        continuation_token:
          description: 'Continuation token that can be provided in the continuation_token

            query param to get the next page of data.

            If you use the continuation token to page through data you

            are guaranteed to get all items exactly once regardless of

            how items are modified. If an item is added or deleted during

            the pagination then it may or may not be returned.

            The continuation token is generated if the limit is less

            than the remaining number of items, and the default sort is used

            (no sort is specified).

            '
          type: string
          example: MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My
        total_item_count:
          description: Total number of items after applying filter params.
          type: integer
          format: int32
          example: 1
    SubscriptionAssetResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionAsset'
    SubscriptionLicenseResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionLicense'
    _fixedReference:
      type: object
      properties:
        id:
          description: The opaque and unique id of this resource.
          type: string
          readOnly: true
          example: 2a989a09-c851-4d52-9ec6-ab728b1c04db
        name:
          description: The name of this resource.
          type: string
          readOnly: true
          example: example_name
        resource_type:
          description: 'The type of this resource represented by the name of its REST endpoint.

            For example, "arrays", "network-interfaces", and "metrics".

            The value may be `null` if the resource is not represented.

            '
          type: string
          readOnly: true
          example: example_resource_type
      x-readOnly: true
    _marketplace_partner:
      type: object
      properties:
        name:
          description: 'Name or identifier of the marketplace parter who owns the

            reference ID.

            '
          type: string
          example: pure1
        reference_id:
          description: 'External ID the marketplace partner knows to refer to this license.

            '
          type: string
    SubscriptionResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
    SubscriptionLicense:
      allOf:
      - $ref: '#/components/schemas/_builtInAsOf'
      - description: 'A license belonging to a Pure1 subscription.

          '
        type: object
        properties:
          add_on_slas:
            description: Add-on SLAs.
            type: array
            items:
              $ref: '#/components/schemas/SubscriptionLicenseAddOnSla'
          average_on_demand:
            description: 'Estimated daily on-demand usage of the license from the current calendar

              quarter to date.

              '
            title: Current_metric
            allOf:
            - $ref: '#/components/schemas/_current_metric'
          expiration_date:
            description: 'Date when the license expires.

              Represented as a timestamp of 00:00 on that date in UTC, in

              milliseconds since UNIX epoch.

              '
            type: integer
            format: int64
            example: 1636238104000
          last_updated_date:
            description: 'The date of the last amendment to the current license.

              Represented as a timestamp of 00:00 on that date in UTC, in

              milliseconds since UNIX epoch.

              '
            type: integer
            format: int64
            example: 1604702243000
          marketplace_partner:
            description: 'Reference information about the marketplace partner of this license.

              '
            title: Marketplace_partner
            allOf:
            - $ref: '#/components/schemas/_marketplace_partner'
          pre_ratio:
            $ref: '#/components/schemas/_subscriptionLicensePreRatio'
          quarter_on_demand:
            description: 'Estimated total on-demand usage of the license of the current calendar quarter to date.

              '
            title: Current_metric
            allOf:
            - $ref: '#/components/schemas/_current_metric'
          reservation:
            description: 'Current reservation amount of the license.

              '
            title: Current_metric
            allOf:
            - $ref: '#/components/schemas/_current_metric'
          resources:
            description: 'References to the resources that operate under this license.

              '
            type: array
            items:
              $ref: '#/components/schemas/_license_resource_reference'
          service_tier:
            description: 'The tier of the service for the license.

              '
            type: string
            example: //Block - Ultra
          site_address:
            description: The license site address.
            title: Base_address
            allOf:
            - $ref: '#/components/schemas/_base_address'
          start_date:
            description: 'Date when the license starts.

              Represented as a timestamp of 00:00 on that date in UTC, in

              milliseconds since UNIX epoch.

              '
            type: integer
            format: int64
            example: 1604702243000
          subscription:
            description: 'A reference to which subscription this license belongs.

              '
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
          usage:
            description: 'Usage of the license, averaged over the last day.

              '
            title: Current_metric
            allOf:
            - $ref: '#/components/schemas/_current_metric'
    PageInfo:
      type: object
      properties:
        continuation_token:
          description: 'Continuation token that can be provided in the `continuation_token`

            query param to get the next page of data.

            If you use the continuation token to page through data you

            are guaranteed to get all items exactly once regardless of

            how items are modified. If an item is added or deleted during

            the pagination then it may or may not be returned.

            The continuation token is generated if the limit is less

            than the remaining number of items, and the default sort is used

            (no sort is specified).

            '
          type: string
        more_items_remaining:
          description: 'Returns a value of `true` if subsequent items can be retrieved.

            '
          type: boolean
          example: false
        total_item_count:
          description: 'The total number of records after applying all filter query parameters.

            The `total_item_count` will be calculated if and only if the corresponding

            query parameter `total_item_count` is set to `true`. If this query parameter

            is not set or set to `false`, a value of `null` will be returned.

            '
          type: integer
          format: int32
  parameters:
    Offset:
      name: offset
      in: query
      description: 'The starting position based on the results of the query

        in relation to the full set of response objects returned.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Filter:
      name: filter
      in: query
      description: 'Narrows down the results to only the response objects

        that satisfy the filter criteria.

        '
      schema:
        type: string
    Subscription_names:
      name: subscription_names
      in: query
      description: 'A comma-separated list of subscription names.

        If there is not at least one resource that matches each `subscription.name`

        element, an error is returned.

        Single

# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-subscriptions-api-openapi.yml