{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/envestnet/json-schema/envestnet-customer-subscriptions-schema.json",
  "title": "customerSubscriptions",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/envestnet-customer-api-openapi.yml#/components/schemas/customerSubscriptions",
  "properties": {
    "customerSubscription": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/CustomerSubscription"
      }
    }
  },
  "$defs": {
    "CustomerConfiguration": {
      "properties": {
        "entityType": {
          "type": "string",
          "description": "The entityType identifies which applicableEntity of the insight the configuration will impact. <br><br>E.g. if the entityType is ACCOUNT, it means that the configurations will impact the ACCOUNT entity during evaluation. <br><br>customerConfiguration, when presented in the userSubscription API, represents the customer preferences. It may or may not match the user preferences. If user preferences differe from customer preferrences in the customerConfiguration, the user preferences will be applied for the insight. <br><br><b>Endpoints</b> -<ul><li>GET insights/configs/customerSubscriptions customer API</li><li>GET insights/configs/userSubscriptions User API</li><li>PATCH /insights/configs/customerSubscriptions cusomter API</li><li>PATCH /insights/configs/userSubscriptions User API</li></ul>",
          "enum": [
            "ACCOUNT",
            "VIEW"
          ]
        },
        "isSubscribed": {
          "type": "boolean",
          "description": "Insight Subscription APIs allow User to subscribe/unsubscribe at any particular entity level. <br><br>If an insight is not subscribed (isSubscribed = false) at the customer level, the insight will not be present in the userSubscription API. <br><br> If an insight is subscribed by the customer (isSubscribed = true), the insight will be subscribed automatically by the user and all the default configurations will be inherited. <br><br>The user can choose to turn off the insight by setting isSubscribed=false. <br><br><b>Endpoints</b> - <ul><li>GET /insights/config/customerSubscriptions</li><li>PATCH /insights/config/customerSubscriptions</li></ul>",
          "enum": [
            true,
            false
          ]
        },
        "frequency": {
          "type": "string",
          "description": "Identifies how often the insight will be evaluated. <br><br>Note - Evaluation does not mean an insight will be generated. If the conditions for generating an insight are not met, the insight will not get generated even after it being evaluated. <br><br>Depending on the insight, it might be editable for customers and users. <br><br><b>Endpoints</b> -<ul><li>GET /insights/config/customerSubscriptions</li><li>PATCH /insights/config/customerSubscriptions</li></ul>",
          "enum": [
            "DAILY",
            "WEEKLY",
            "MONTHLY",
            "MID_MONTHLY"
          ]
        },
        "duration": {
          "type": "string",
          "description": "Identifies the duration for which the data will be considered to generate and insight. <br><br>Note <ul> <li>Even if the duration mentioned is ONE_YEAR, the insight can consider only data that exists. If there is data only for one month, the insight will be generated using the available one month data.</li> <li>Duration is insight specific. For some insights which are REFRESH based, duration might not be applicable. For certain insights, only a subset of the duration might be applicable.</li> </ul> <b>Endpoints</b> -<ul><li>GET /insights/config/customerSubscriptions</li><li>PATCH /insights/config/customerSubscriptions</li></ul>",
          "enum": [
            "THIS_MONTH",
            "LAST_MONTH",
            "THREE_MONTHS",
            "SIX_MONTHS",
            "ONE_YEAR",
            "LAST_THREE_MONTHS",
            "LAST_SIX_MONTHS",
            "LAST_TWELVE_MONTHS"
          ]
        },
        "threshold": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Threshold"
          }
        },
        "isBenchmarkEnabled": {
          "type": "boolean",
          "description": "Identifies if peer benchmarking is enabled for a particular insight. The attribute will be returned only for insights that are eligible for peer benchmarking data points\n <br><br>The default value of this attribute will be based on the global configuration key to enable/disable peer benchmarking. If the global configuration is true, this attribute will be true and if the global configuration is false, this value will be false.\n <br><br>If the peer benchmarking is enabled by the customer (isBenchmarkEnabled = true), the benchmarks will be subscribed automatically by the user.\n <br><br>The user can choose to turn off the benchmark configuration for the insight by setting isBenchmarkEnabled=false.\n <br><br><b>Note</b> - There are few insights for which the isBenchmarkEnabled attribute cannot be updated since benchmark amount is essential for the insight evaluation.\n <br><br><b>Endpoints</b> - <ul><li>GET\n/insights/config/customerSubscriptions</li><li>PATCH /insights/config/customerSubscriptions</li></ul>",
          "enum": [
            true,
            false
          ]
        }
      }
    },
    "CustomerSubscription": {
      "allOf": [
        {
          "$ref": "#/$defs/Subscription"
        }
      ],
      "properties": {
        "customerConfiguration": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CustomerConfiguration"
          }
        }
      }
    },
    "Subscription": {
      "description": "Details about the configurations applied for the specific insight.",
      "properties": {
        "insightName": {
          "type": "string",
          "description": "Unique name of each Insight in the system. 2 Insight can not have same Insight 'name'. If User wants to update his/her Subscription details, then While calling the PATCH Subscription API this 'name' field is mandatory.<br><br><b>Endpoints</b> -<ul><li>GET insights/configs/customerSubscriptions customer API</li><li>GET insights/configs/userSubscriptions User API</li><li>PATCH /insights/configs/customerSubscriptions cusomter API</li><li>PATCH /insights/configs/userSubscriptions User API</li></ul>"
        },
        "insightTitle": {
          "type": "string",
          "description": "Title of the Insight. This is an editable field by calling PATCH Subscription APIs.<br><br><b>Endpoints</b> -<ul><li>GET insights/configs/customerSubscriptions customer API</li><li>GET insights/configs/userSubscriptions User API</li><li>PATCH /insights/configs/customerSubscriptions cusomter API</li></ul>"
        },
        "insightType": {
          "type": "string",
          "description": "Identifies whether the insight is generated at an entity-level (per account or per view), or if it considers all entities for the user - e.g.  all accounts. <br><br>Note - Do not pass the insightType attribute when doing a PATCH rquest. <br><br><b>Endpoints</b> -<ul><li>GET insights/configs/customerSubscriptions customer API</li><li>GET insights/configs/userSubscriptions User API</li></ul>",
          "readOnly": true,
          "enum": [
            "OTHER",
            "AGGREGATE"
          ]
        },
        "triggerType": {
          "type": "string",
          "description": "triggerType of an insight defines how an Insight will be triggered in the system. <br><br>Currently following triggerType are supported - <ul> <li><b>SCHDEULE</b> - Insight evaluation and subsequent generation will be triggered based on a pre-defined schedule. This schedule may be editable by the customer depending on the insight.</li> <li><b>REFRESH</b> - Insight evaluation and subsequent generation will be triggered when a user's account gets successfully refreshed.</li> <li><b>EVENT</b> - Insight evaluation and subsequent generation will be triggered based on a system-defined event happening.</li> </ul> <b>Note</b> <br><br>If triggerType=SCHEDULE, then the UserSubscription/CobrandSubscription API attribute 'frequency' and 'duration' may be applicable depending on the insight. <br><br><b>Endpoints</b> <ul> <li>GET /insights/config/customerSubscriptions</li> </ul>",
          "readOnly": true,
          "enum": [
            "SCHEDULE",
            "REFRESH",
            "EVENT"
          ]
        },
        "containers": {
          "type": "array",
          "description": "Identifies the containers considered for generating an insight. <br><br><b>Endpoints</b> <ul><li>GET /insights/config/customerSubscriptions</li> </ul>",
          "readOnly": true,
          "items": {
            "type": "string"
          },
          "enum": [
            "BANK",
            "CARD",
            "LOAN",
            "INVESTMENT",
            "REALESTATE"
          ]
        },
        "description": {
          "type": "string",
          "description": "A simple english description of the Insight. <br><br><b>Endpoints</b> -<ul><li>GET /insights/config/customerSubscriptions</li></ul>",
          "readOnly": true
        },
        "applicableEntity": {
          "type": "array",
          "description": "Identifies which entity (Account or View) the insight is applicable for. <br><br>When applicableEntity is provided in the userSubscription or customerSubscription, it identifies all the entities for which the insight is capable of being generated. <br><br>When the attribute is present in the feed API, it identifies the entitiy for which the insight was generated. </li></ul><b>Endpoints</b> -<ul><li>GET /insights/config/customerSubscriptions</li></ul>",
          "readOnly": true,
          "items": {
            "type": "string"
          },
          "enum": [
            "ACCOUNT",
            "VIEW"
          ]
        }
      }
    },
    "Threshold": {
      "properties": {
        "name": {
          "type": "string",
          "description": "Identifies the threshold applicable for an insight. Threshold values impact insight generation.Consider the following example - <ul> <li>name = CHANGE</li> <li>type = PERCENT</li> <li>value = 3</li> </ul> For the above insight, you can read the configuration as \"Generate the insight only if the change is >= 3%\" <br><br><b>Note</b>- Threshold is fixed for each insight. Only value is editable. <br><br><b>Endpoints</b> -<ul><li>GET /insights/configs/customerSubscriptions Cobrand API</li><li>PATCH /insights/configs/customerSubscriptions Cobrand API</li><li>GET /insights/configs/userSubscriptions User API</li><li>PATCH /insights/configs/userSubscriptions User API</li></ul>",
          "enum": [
            "CHANGE",
            "UPPER_LIMIT",
            "DAYS_BEFORE",
            "MINIMUM",
            "FUTURE",
            "DELAY",
            "TOP",
            "BASETYPE"
          ]
        },
        "type": {
          "type": "string",
          "description": "Identifies the type of threshold. Threshold values impact insight generation.Consider the following example - <ul> <li>name = CHANGE</li> <li>type = PERCENT</li> <li>value = 3</li> </ul> For the above insight, you can read the configuration as \"Generate the insight only if the change is >= 3%\". <br><br>However, consider changing the configuration to as follows by  changing the type - <ul> <li>name = CHANGE</li> <li>type = AMOUNT</li> <li>value = 300</li> </ul> For the above insight, you can read the configuration as \"Generate the insight only if the change is >= $300\". <br><br><b>Note</b>- For a single insight, you can have multiple thresholds. If multiple thresholds have values set to a non-zero number, the relationship between the thresholds will be logical AND. <br><br>Some insights will have type as AMOUNT and PERCENT. In the above scenario, if you want to generate insight only based on one value, you can set the other to 0. <br><br>E.g. if type = AMOUNT is set to 0 and type = PERCENT is set to 3, the insight will be evaluated as \"Generate the insight only if the change is >= 3%\" <br><br>However, if AMOUNT = $300 and PERCENT = 3, the insight will be evaluated as \"Generate the insight only if the change % is >= 3% AND change amount >= $300\" <br><br><b>Endpoints</b> -<ul><li>GET config/insights/subscriptions Cobrand API</li><li>PATCH /config/insights/subscriptions Cobrand API</li><li>GET /insights/subscriptions User API</li><li>PATCH /insights/subscriptions User API</li></ul>",
          "enum": [
            "PERCENT",
            "NUMBER",
            "DAYS",
            "AMOUNT",
            "STRING"
          ]
        },
        "value": {
          "type": "string",
          "description": "The value set for the threshold. 0 is allowed only if there are multiple threshold for the same insight. <br><br><b>Endpoints</b> - <ul><li>GET /config/insights/subscriptions Cobrand API</li><li>PATCH /config/insights/subscriptions Cobrand API</li><li>GET insights/subscriptions User API</li><li>PATCH /insights/subscriptions User API</li></ul>"
        }
      }
    }
  }
}