Upcoming Subscriptions - All Accounts

Overview

The Upcoming Subscriptions - All Accounts insight is a schedule-triggered insight that alerts the user about the upcoming recurring subscriptions due for the user-specified duration for all the bank or card accounts.

The Predicted Cash Flow feature has to be enabled as a pre-requisite for this insight.

Note: Only subscriptions that the system has identified as recurring subscriptions will be part of this insight.

Following are the additional details for the insight:

Insight Name UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS
Applicable Entity ACCOUNT
Insight Type AGGREGATE
Trigger Type SCHEDULE
Supported Containers BANK, CARD

Use Cases

  • Customer:
    • User engagement
  • User:
    • Financial wellness - Be financially prepared.

Suggested Action

NA

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for a user.

Following are the applicable frequencies for this insight:

Frequency Description
DAILY The insight will be triggered daily. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current day from 12:00 AM same day to the time of insight evaluation.
WEEKLY The insight will be triggered once every Monday. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar week (Monday to Sunday).
For example:
  • Normal scenario: If the calendar week starts from 1st January to 7th January, the insight is triggered on 1st January.
  • Dynamic trigger scenario: If the calendar week starts from 1st January to 7th January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.
MONTHLY The insight will be triggered once on the first day of the calendar month. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar month (1st of the calendar month to the last day of the month).
For example:
  • Normal scenario: If the calendar month starts from 1st January to 31st January, the insight is triggered on 1st January.
  • Dynamic trigger scenario: If the calendar month starts from 1st January to 31st January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.
MID_MONTHLY The insight will be triggered once on the 16th of a calendar month. Duplicate check will evaluate if the insight instance that matches the duplicate check criteria exists for the current calendar month (1st of the calendar month to the last day of the month).
For example:
  • Normal scenario: If the calendar month starts from 1st January, the insight is triggered on 16th of January.
  • Dynamic trigger scenario: If the calendar month starts from 1st January, and the user triggers an insight on 3rd January using dynamic trigger, duplicate check happens from 1st January to 3rd January.

Insight Dynamic Trigger (On-Demand Evaluation)

The insight can be triggered using the following on-demand insight trigger API:

POST   /insights/trigger

Peer Benchmarking Data

This insight does not provide peer benchmarking data.

Thresholds

Threshold lets the customer or the user decide how many days in the FUTURE, the system will look to identify upcoming subscriptions. If FUTURE is set as 9, the system will look forward 9 days from the day of evaluation. Any instances of Active series that fall within these 9 days (including both the upper and lower bounds), will be considered for inclusion in the insight.

  • Threshold Name: FUTURE
  • Data Type: DAYS
  • Range Allowed: 0 <= Number of Days <= 31
  • Default: 7

Note: Depending on the customer segment and account, threshold might need to be different for different users. If the default value is insufficient, the users can set a threshold they are comfortable tracking.

GET Customer Subscription

The GET customer subscription API provides all the information about the defaults set for the insights that are subscribed by the customer. The default frequency for the insight is WEEKLY.

Method and URL:

GET   /insights/configs/customerSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}
Content-Type application/json
Api-Version 2
Cobrand-Name {Name of the Customer}

Sample Request:

/insights/configs/customerSubscriptions

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

{
   "customerSubscription":[
      {
         "insightName":"UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS",
         "insightTitle":"Upcoming Subscriptions – All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "container":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight that lists upcoming recurring subscriptions for all the applicable accounts of the user within a configured time period.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"WEEKLY",
               "threshold":[
                  {
                     "name":"FUTURE",
                     "value":"7",
                     "type":"DAYS"
                  }
               ]
            }
         ]
      }
   ]
}

PATCH Customer Subscription

Using the PATCH API for customer subscription, customers can change the defaults for each insight. Alternatively, customers can use the insights configuration tool to achieve the same result.

Warning! Changing any defaults can potentially impact all users who have subscribed to this insight. If the user has overridden the customer threshold, then the user preference will be applied. For all other users, the new defaults will apply.

Method and URL:

PATCH   /insights/configs/customerSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}
Content-Type application/json
Api-Version 2
Cobrand-Name {Name of the Customer}

Editable Parameters:

Editable Attributes Impact Allowed Values
isSubscribed Subscribes or unsubscribes all the users from the Upcoming Subscriptions - All Accounts insight. true, false
insightTitle The title returned in the GET feed API as well as the insights config tool can be changed. Alphanumeric characters up to 100 characters (including spaces)
frequency The frequency at which an insight will be evaluated.
  • DAILY (Every day - Early Morning)
  • WEEKLY (every Monday - early morning)
  • MONTHLY (1st of every month - early morning)
  • MID_MONTHLY (16th of every month - early morning)
threshold The threshold value (FUTURE) for generating the Upcoming Subscriptions - All Accounts insight can be changed. Any number between 0 and 31.

Sample Request:

{
   "customerSubscription":[
      {
         "insightName":"UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS",
         "insightTitle":"Upcoming Subscriptions – All Accounts",
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"WEEKLY",
               "threshold":[
                  {
                     "name":"FUTURE",
                     "value":"7",
                     "type":"DAYS"
                  }
               ]
            }
         ]
      }
   ]
}

Response Messages:

HTTP Status Code Reason
400 Y806: Invalid Input
400 Y800: Invalid value for insightName
400 Y800: Invalid value for insightTitle; special characters ></\""'%{}|^~[] are not supported.
400 Y801: Invalid length for insightTitle; min 3 and max 100 characters including spaces are allowed.
400 Y800: Invalid value for FUTURE in UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS insight Min = 0 and Max = 31
400 Y813: Invalid request. The entire object within threshold should be provided
400 Y802: For insight UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS, modifying applicableEntity is not allowed
400 Y802: For insight UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS, modifying triggerType is not allowed
400 Y802: For insight UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS, modifying container is not allowed
400 Y802: For insight UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS, modifying description is not allowed
400 Y800: Invalid value for isSubscribed; Supported values are true, false
400 Y825: Update not allowed without a valid request body
400 Y803: Invalid request; Either a valid insightTitle or customerConfiguration is required.
400 Y800: Invalid value for frequency; Supported values are DAILY, WEEKLY, MONTHLY, MID_MONTHLY
400 Y802: Specifying duration attribute for UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS insight is not allowed
400 Y812: Required field/value - insightName missing in the request
400 Y802: Modifying InsightType attribute is not allowed
400 Y813: entityType should be provided
400 Y803: At least one additional attribute is required in addition to entityType.
400 Y800: Invalid value for customerConfiguration; customerConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes.
400 Y800: Invalid value for entityType. Supported entityType for UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS insight are - [ACCOUNT]
400 Y802: For UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS insight, {Invalid String} inside the threshold is either repeated or not allowed
400 Y802: For UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS insight, {Invalid String} inside the threshold is not allowed
400 Y800 : Invalid value for input json
401 Y020: Invalid token in authorization header
401 Y020: Token has expired

GET User Subscription

The GET user subscription API provides all the information about the user defaults set for the insight.

The entityId filter is not applicable for this insight.

Method and URL:

GET   /insights/configs/userSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}
Content-Type application/json
Api-Version 2
Cobrand-Name {Name of the Customer}

Sample Request:

/insights/configs/userSubscriptions?insightName=UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

{
   "userSubscription":[
      {
         "insightName":"UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS",
         "insightTitle":"Upcoming Subscriptions – All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "container":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight that lists upcoming recurring subscriptions for all the applicable accounts of the user within a configured time period.",
         "applicableEntity":[
            "ACCOUNT"
         ],
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"WEEKLY",
               "threshold":[
                  {
                     "name":"FUTURE",
                     "value":"7",
                     "type":"DAYS"
                  }
               ]
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"WEEKLY",
               "threshold":[
                  {
                     "name":"FUTURE",
                     "value":"7",
                     "type":"DAYS"
                  }
               ]
            }
         ]
      }
   ]
}

PATCH User Subscription

Using the PATCH user subscription API for user subscription, users can change the defaults for each insight. If the user wants the insight to be evaluated for a new account, then add that account using the PATCH user subscription API. The customer default threshold values will apply if the user has not set any values.

Method and URL:

PATCH   /insights/configs/userSubscriptions

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}
Content-Type application/json
Api-Version 2
Cobrand-Name {Name of the Customer}

Editable Parameters:

Editable Attributes Impact Allowed Values
isSubscribed Subscribes or unsubscribes from the Upcoming Subscriptions- All Accounts insight. true, false
frequency The frequency at which an insight will be evaluated.
  • DAILY (Every day - Early Morning)
  • WEEKLY (every Monday - early morning)
  • MONTHLY (1st of every month - early morning)
  • MID_MONTHLY (16th of every month - early morning)
threshold The threshold value (FUTURE) for generating the Upcoming Subscriptions- All Accounts insight can be changed. Any number between 0 and 31.

Sample Request:

{
   "userSubscription":[
      {
         "insightName":"UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS",
         "userConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"WEEKLY",
               "threshold":[
                  {
                     "name":"FUTURE",
                     "value":"7",
                     "type":"DAYS"
                  }
               ]
            }
         ]
      }
   ]
}

Error Messages:

HTTP Status Code Reason
400 Y806: Invalid input
400 Y800: Invalid value for insightName
400 Y800: Invalid value for input param in UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS insight
400 Y800: Invalid value for threshold data in UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS insight
400 Y800: Invalid value for FUTURE in UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS insight Min = 0 and Max = 31
400 Y802: Modifying insightTitle using this API is not allowed
400 Y813: Invalid request. The entire object within threshold should be provided
400 Y802: For insight UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS, modifying applicableEntity is not allowed
400 Y802: For insight UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS, modifying triggerType is not allowed
400 Y802: For insight UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS, modifying container is not allowed
400 Y802: For insight UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS, modifying description is not allowed
400 Y800: Invalid value for frequency; Supported values are DAILY, WEEKLY, MONTHLY, MID_MONTHLY
400 Y802: Specifying duration attribute for UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS insight is not allowed
400 Y800: Invalid value for isSubscribed; Supported values are true, false
400 Y825: Update not allowed without a valid request body
400 Y812: Required field/value - insightName missing in the request
400 Y802: Modifying InsightType attribute is not allowed
400 Y813: entityType should be provided
400 Y802: For insight UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS, configurations at an entityId level are not allowed
400 Y803: At least one additional attribute is required in addition to entityType.
400 Y800: Invalid value for userConfiguration; userConfiguration is either missing, duplicated, or has insufficient/ incorrect attributes
400 Y800: Invalid value for entityType. Supported entityType for UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS insight are - [ACCOUNT]
400 Y800 : Invalid value for input json
401 Y020: Invalid token in authorization header
401 Y020: Token has expired

GET Insight Feeds

The GET insights feed API retrieves all or a subset of the valid insight notifications generated for a particular user. However, using the insightName filter, the Upcoming Subscriptions - All Accounts insight can be specifically requested.

The entityId filter is not applicable for this insight.

Method and URL:

GET   /insights/feed

Header Parameters:

Key Value
Authorization Client credentials-based authorization Bearer {{Access Token}}
API key-based authentication Bearer {{JWT Token_Customer}}
Deprecated cobrand and user credential-based authentication cobSession={cobSession received in the cobrand login service}, userSession={userSession received in the user login service}
Content-Type application/json
Api-Version 2
Cobrand-Name {Name of the Customer}

Sample Request:

/insights/feed?insightName=UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS

Sample Response:

For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.

{
   "feed":[
      {
         "id":"619b15c3227dae632e7da750",
         "insightName":"UPCOMING_SUBSCRIPTIONS_ALL_ACCOUNTS",
         "insightTitle":"Upcoming Subscriptions – All Accounts",
         "insightType":"AGGREGATE",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-11-22T04:00:03Z",
         "subscription":[
            {
               "entityType":"ACCOUNT",
               "frequency":"WEEKLY",
               "threshold":[
                  {
                     "name":"FUTURE",
                     "value":"8",
                     "type":"DAYS"
                  }
               ]
            }
         ],
         "basicAccount":[
            {
               "id":14278024,
               "providerName":"Dag Site",
               "accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=14278024"
               },
               "basicTransaction":[
                  {
                     "id":20135107,
                     "amount":{
                        "amount":300.00,
                        "currency":"USD"
                     },
                     "date":"2021-11-23",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=20135107"
                     },
                     "categoryId":20,
                     "category":"Personal Care",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "simple":"RECURRING PAYMENT AUTHORIZED ON 00/00 LA FITNESS 000-000-0000 CA S000000000000000 CARD 0000",
                        "consumer":"RECURRING AUTHORIZED ON 00/00 LA FITNESS XX-0000 CA SXX0000 CARD 0000"
                     },
                     "sourceType":"SYSTEM_PREDICTED",
                     "merchantType":"SUBSCRIPTION"
                  },
                  {
                     "id":20135124,
                     "amount":{
                        "amount":300.00,
                        "currency":"USD"
                     },
                     "date":"2021-11-22",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=20135124"
                     },
                     "categoryId":7,
                     "category":"Entertainment",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "simple":"NetFlix Payment",
                        "consumer":"Netflix"
                     },
                     "sourceType":"SYSTEM_PREDICTED",
                     "merchantType":"SUBSCRIPTION",
                     "basicMerchant":{
                        "name":"Netflix"
                     }
                  }
               ],
               "detail":[
                  {
                     "date":"2021-11-22",
                     "predictedBalance":{
                        "amount":17700.00,
                        "currency":"USD"
                     }
                  },
                  {
                     "date":"2021-11-23",
                     "predictedBalance":{
                        "amount":17400.00,
                        "currency":"USD"
                     }
                  }
               ],
               "accountStatus":"ACTIVE"
            },
            {
               "id":14278021,
               "providerName":"Dag Site",
               "accountName":"PDV Test Data-Event",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=14278021"
               },
               "basicTransaction":[
                  {
                     "id":20135114,
                     "amount":{
                        "amount":300.00,
                        "currency":"USD"
                     },
                     "date":"2021-11-22",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=20135114"
                     },
                     "categoryId":7,
                     "category":"Entertainment",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "simple":"NetFlix Payment",
                        "consumer":"Netflix"
                     },
                     "sourceType":"SYSTEM_PREDICTED",
                     "merchantType":"SUBSCRIPTION",
                     "basicMerchant":{
                        "name":"Netflix"
                     }
                  },
                  {
                     "id":20135086,
                     "amount":{
                        "amount":300.00,
                        "currency":"USD"
                     },
                     "date":"2021-11-22",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=20135086"
                     },
                     "categoryId":20,
                     "category":"Personal Care",
                     "categoryType":"EXPENSE",
                     "baseType":"DEBIT",
                     "description":{
                        "simple":"RECURRING PAYMENT AUTHORIZED ON 00/00 LA FITNESS 000-000-0000 CA S000000000000000 CARD 0000",
                        "consumer":"RECURRING AUTHORIZED ON 00/00 LA FITNESS XX-0000 CA SXX0000 CARD 0000"
                     },
                     "sourceType":"SYSTEM_PREDICTED",
                     "merchantType":"SUBSCRIPTION"
                  }
               ],
               "detail":[
                  {
                     "date":"2021-11-22",
                     "predictedBalance":{
                        "amount":179700.00,
                        "currency":"USD"
                     }
                  }
               ],
               "accountStatus":"ACTIVE"
            }
         ],
         "predictedInfoDerived":[
            {
               "date":"2021-11-23",
               "accountId":[
                  "14278024"
               ],
               "predictedBalance":{
                  "amount":197100.00,
                  "currency":"USD"
               }
            },
            {
               "date":"2021-11-22",
               "accountId":[
                  "14278024",
                  "14278021"
               ],
               "predictedBalance":{
                  "amount":197400.00,
                  "currency":"USD"
               }
            }
         ]
      }
   ]
}