Upcoming Subscriptions
Overview
The Upcoming Subscriptions insight is a schedule-trigger insight that lets the user know about the upcoming recurring subscriptions due for the user-specified duration for a specific bank or card account.
The insight for VIEW is generated only if the VIEW rule contains merchantType as a SUBSCRIPTION. For VIEW insights, only EXPENSE rules are considered.
The Predicted Cash Flow feature has to be enabled as a pre-requisite for this insight.
Note: Only the 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 |
|---|---|
| Applicable Entities | ACCOUNT, VIEW |
| Insight Type | OTHER |
| 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 each transaction ID per entity ID.
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:
|
|
| 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:
|
|
Insight Dynamic Trigger (On-Demand Evaluation)
The dynamic trigger is applicable to the insight. Depending on the configuration, this insight can be invoked dynamically when:
- A new View is created
OR - A View ID is patched using the user subscription API
The insight is generated dynamically using any of the above two methods only if the view is eligible and the other insight generation checks are passed.
Note: By default, the configuration is set to dynamically trigger insight evaluation, everytime a new entityId (view ID) is added using the PATCH userSubscription API. During onboarding, this preference can be changed.
In addition to the dynamic trigger capability chosen, this insight can be triggered using the following on-demand insight trigger API:
Method and URL:
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 DAILY.
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 |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /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.
- Api-Version 3.0 and 2.1 Response
{
"customerSubscription":[
{
"insightName":"UPCOMING_SUBSCRIPTIONS",
"insightTitle":"Upcoming Subscriptions",
"insightType":"OTHER",
"triggerType":"SCHEDULE",
"containers":[
"BANK",
"CARD"
],
"description":"Generates an insight that lists upcoming recurring subscriptions within a configured time period.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName":"UPCOMING_SUBSCRIPTIONS",
"insightTitle":"Upcoming Subscriptions",
"insightType":"OTHER",
"triggerType":"SCHEDULE",
"container":[
"BANK",
"CARD"
],
"description":"Generates an insight that lists upcoming recurring subscriptions within a configured time period.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"frequency":"DAILY",
"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 |
3.0 |
|
2.1 |
||
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 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. |
|
| threshold | Determines the number of future days that will get evaluated to find upcoming subscriptions. | Any number between 0 and 31. |
Sample Request:
{
"customerSubscription": [
{
"insightName": "UPCOMING_SUBSCRIPTIONS",
"insightTitle": "Upcoming Subscriptions",
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true,
"frequency": "DAILY",
"threshold": [
{
"name": "FUTURE",
"value": "7",
"type": "DAYS"
}
]
},
{
"entityType": "VIEW",
"isSubscribed": true,
"frequency": "DAILY",
"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 insight Min =0 and Max = 31 |
| 400 | Y802: For insight UPCOMING_SUBSCRIPTIONS, modifying applicableEntity is not allowed |
| 400 | Y802: For insight UPCOMING_SUBSCRIPTIONS, modifying triggerType is not allowed |
| 400 | Y802: For insight UPCOMING_SUBSCRIPTIONS, modifying container is not allowed |
| 400 | Y802: For insight UPCOMING_SUBSCRIPTIONS, modifying description is not allowed |
| 400 | Y800: Invalid value for frequency Supported values are DAILY, WEEKLY, MONTHLY |
| 400 | Y802: Specifying duration attribute for UPCOMING_SUBSCRIPTIONS 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 | Y803: Invalid request; Either a valid insightTitle or customerConfiguration is required. |
| 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 insight are - [ACCOUNT, VIEW] |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: For UPCOMING_SUBSCRIPTIONS insight, {Invalid String} inside the threshold is either repeated or not allowed |
| 400 | Y802: For UPCOMING_SUBSCRIPTIONS 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.
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 |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /insights/configs/userSubscriptions?insightName=UPCOMING_SUBSCRIPTIONS
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
- Api-Version 3.0 and 2.1 Response
{
"userSubscription":[
{
"insightName":"UPCOMING_SUBSCRIPTIONS",
"insightTitle":"Upcoming Subscriptions",
"insightType":"OTHER",
"triggerType":"SCHEDULE",
"containers":[
"BANK",
"CARD"
],
"description":"Generates an insight that lists upcoming recurring subscriptions within a configured time period.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName":"UPCOMING_SUBSCRIPTIONS",
"insightTitle":"Upcoming Subscriptions",
"insightType":"OTHER",
"triggerType":"SCHEDULE",
"container":[
"BANK",
"CARD"
],
"description":"Generates an insight that lists upcoming recurring subscriptions within a configured time period.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"frequency":"DAILY",
"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 or a new view, then add that account or view 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 |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Editable Parameters:
| Editable Attributes | Impact | Allowed Values |
|---|---|---|
| entityId | The ID of the account or view for which the insight gets evaluated. | Valid IDs for accounts or views belonging to the user. |
| isSubscribed | Subscribes or unsubscribes from the Upcoming Subscriptions insight. | true, false |
| frequency | The frequency at which an insight will be evaluated. |
|
| threshold | Determines the number of future days that will get evaluated to find upcoming subscriptions. | Any number between 0 and 31. |
Sample Request:
{
"userSubscription": [
{
"insightName": "UPCOMING_SUBSCRIPTIONS",
"userConfiguration": [
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed": true,
"frequency": "DAILY",
"threshold": [
{
"name": "FUTURE",
"value": "7",
"type": "DAYS"
}
]
},
{
"entityType": "VIEW",
"isSubscribed": true,
"frequency": "DAILY",
"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 insight |
| 400 | Y800: Invalid value for frequency Supported values are DAILY, WEEKLY, MONTHLY |
| 400 | Y802: Specifying duration attribute for UPCOMING_SUBSCRIPTIONS insight is not allowed |
| 400 | Y800: Invalid value for entityId; This id is either invalid or not supported for this insight. |
| 400 | Y800: Invalid value for FUTURE in UPCOMING_SUBSCRIPTIONS insight Min =0 and Max = 31 |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: Modifying insightTitle using this API is not allowed |
| 400 | Y802: For insight UPCOMING_SUBSCRIPTIONS, modifying applicableEntity is not allowed |
| 400 | Y802: For insight UPCOMING_SUBSCRIPTIONS, modifying triggerType is not allowed |
| 400 | Y802: For insight UPCOMING_SUBSCRIPTIONS, modifying container is not allowed |
| 400 | Y802: For insight UPCOMING_SUBSCRIPTIONS, modifying description is not allowed |
| 400 | Y802: Duplicate entityId entries within userConfiguration 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 | Y800: Invalid value for userConfiguration; entityId should be provided. |
| 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: Duplicate entityId entries is 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 insight are - [ACCOUNT, VIEW] |
| 400 | Y800: Invalid value for threshold data in UPCOMING_SUBSCRIPTIONS insight |
| 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, you can specifically request for the Upcoming Subscriptions insight only.
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 |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /insights/feed?insightName=UPCOMING_SUBSCRIPTIONS
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
{
"feed":[
{
"id":"60d43df3d59fdb46b0c91279",
"insightName":"UPCOMING_SUBSCRIPTIONS",
"insightTitle":"Upcoming Subscriptions",
"insightType":"OTHER",
"triggerType":"SCHEDULE",
"createdDate":"2021-06-24T08:10:27Z",
"subscription":[
{
"entityId":"60d43caaf74fce189c9cf1bb",
"entityType":"VIEW",
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
}
],
"basicView":[
{
"id":"60d43caaf74fce189c9cf1bb",
"name":"View 1",
"link":{
"entityName":"view",
"url":"/views/60d43caaf74fce189c9cf1bb"
},
"basicAccount":[
{
"id":13709571,
"providerName":"Dag Site",
"accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709571"
},
"basicTransaction":[
{
"id":19504083,
"amount":{
"amount":300.0,
"currency":"USD"
},
"date":"2021-06-28",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=19504083"
},
"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",
"basicMerchant":{
"name":"LA Fitness"
}
},
{
"id":19504139,
"amount":{
"amount":300.0,
"currency":"USD"
},
"date":"2021-06-25",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=19504139"
},
"categoryId":7,
"category":"Entertainment",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"NetFlix Payment",
"consumer":"NetFlix"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"Netflix"
}
}
]
}
]
}
]
},
{
"id":"60d43dbad59fdb46b0c91204",
"insightName":"UPCOMING_SUBSCRIPTIONS",
"insightTitle":"Upcoming Subscriptions",
"insightType":"OTHER",
"triggerType":"SCHEDULE",
"createdDate":"2021-06-24T08:09:30Z",
"subscription":[
{
"entityId":"13709571",
"entityType":"ACCOUNT",
"frequency":"DAILY",
"threshold":[
{
"name":"FUTURE",
"value":"7",
"type":"DAYS"
}
]
}
],
"basicAccount":[
{
"id":13709571,
"providerName":"Dag Site",
"accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=13709571"
},
"basicTransaction":[
{
"id":19504083,
"amount":{
"amount":300.0,
"currency":"USD"
},
"date":"2021-06-28",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=19504083"
},
"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",
"basicMerchant":{
"name":"LA Fitness"
}
},
{
"id":19504139,
"amount":{
"amount":300.0,
"currency":"USD"
},
"date":"2021-06-25",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=19504139"
},
"categoryId":7,
"category":"Entertainment",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"NetFlix Payment",
"consumer":"NetFlix"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"Netflix"
}
}
]
}
]
}
]
}