Subscription Changed
Overview
The Subscription Changed insight is an event-triggered insight that alerts the user whenever a recurring subscription payment amount changes by a user-configured threshold.
The insight for VIEW is generated only if the VIEW rule contains merchantType as a SUBSCRIPTION.
The Predicted Cash Flow feature has to be enabled as a pre-requisite for this insight.
Following are the additional details for the insight:
| Insight Name | SUBSCRIPTION_CHANGED |
|---|---|
| Applicable Entities | ACCOUNT, VIEW |
| Insight Type | OTHER |
| Trigger Type | EVENT |
| Supported Containers | BANK, CARD |
Use Cases
- Customer:
- User engagement
- User:
- Financial wellness - Uncover hidden changes in subscription fees.
Suggested Action
Suggest the user to review the subscription payment terms and if the subscription was upgraded or downgraded by the user, update the event using the following update Predicted Cash Flow API so that the new data is reflected in the event.
Method and URL:
PUT /predictedEvents/{predictedEventId}
Duplicate Insight Checks
To prevent the same insight from generating repeatedly, the insight is generated once every 31 days (including the date of insight evaluation) for each of the applicable transaction IDs for each recurring event (subscription instance) per entity ID.
Insight Dynamic Trigger (On-Demand Evaluation)
The insight cannot be triggered on-demand using any of the on-demand trigger mechanisms currently available.
Peer Benchmarking Data
This insight does not provide peer benchmarking data.
Thresholds
Threshold lets the customer or the user decide when the user has to be alerted about a change in the bill amount. If the difference between the latest bill amount and the previous bill amount exceeds the configured CHANGE AMOUNT and CHANGE PERCENT, an insight is generated for the user.
- Threshold Name: CHANGE
- Data Type: AMOUNT
- Range Allowed: 0.01 <= MINIMUM <= 10000.00
- Default: 10.00
- Threshold Name: CHANGE
- Data Type: PERCENT
- Range Allowed: 0.00 <= MINIMUM <= 500.00
- Default: 10.00
Note: Only USD currency is currently supported. 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.
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":"SUBSCRIPTION_CHANGED",
"insightTitle":"Subscription Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"containers":[
"BANK",
"CARD"
],
"description":"Generates an insight when a recurring Subscription changes by more than a configured threshold.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName":"SUBSCRIPTION_CHANGED",
"insightTitle":"Subscription Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"container":[
"BANK",
"CARD"
],
"description":"Generates an insight when a recurring Subscription changes by more than a configured threshold.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
]
}
]
}
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 Subscription Changed insights | 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) |
| threshold | The following threshold values can be changed:
|
|
Sample Request:
{
"customerSubscription":[
{
"insightName":"SUBSCRIPTION_CHANGED",
"insightTitle":"Subscription Changed",
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
]
}
]
}
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 CHANGE in SUBSCRIPTION_CHANGED insight Min = 0.01 and Max =10000.00 |
| 400 | Y800: Invalid value for CHANGE in SUBSCRIPTION_CHANGED insight Min = 0.00 and Max =500.00 |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: For insight SUBSCRIPTION_CHANGED, modifying applicableEntity is not allowed |
| 400 | Y802: For insight SUBSCRIPTION_CHANGED, modifying triggerType is not allowed |
| 400 | Y802: For insight SUBSCRIPTION_CHANGED, modifying container is not allowed |
| 400 | Y802: For insight SUBSCRIPTION_CHANGED, 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 | Y802: Specifying frequency attribute for SUBSCRIPTION_CHANGED insight is not allowed |
| 400 | Y802: Specifying duration attribute for SUBSCRIPTION_CHANGED 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 SUBSCRIPTION_CHANGED insight are - [ACCOUNT, VIEW] |
| 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=SUBSCRIPTION_CHANGED
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":"SUBSCRIPTION_CHANGED",
"insightTitle":"Subscription Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"containers":[
"BANK",
"CARD"
],
"description":"Generates an insight when a recurring Subscription changes by more than a configured threshold.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName":"SUBSCRIPTION_CHANGED",
"insightTitle":"Subscription Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"container":[
"BANK",
"CARD"
],
"description":"Generates an insight when a recurring Subscription changes by more than a configured threshold.",
"applicableEntity":[
"ACCOUNT",
"VIEW"
],
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
]
}
]
}
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 Subscription Changed insights | true, false |
| threshold | The following threshold values can be changed:
|
|
Sample Request:
{
"userSubscription":[
{
"insightName":"SUBSCRIPTION_CHANGED",
"userConfiguration":[
{
"entityType": "ACCOUNT",
"entityId": "10255809",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
},
{
"entityType":"VIEW",
"isSubscribed":true,
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
]
}
]
}
Response Messages:
| HTTP Status Code | Reason |
|---|---|
| 400 | Y806: Invalid input |
| 400 | Y800: Invalid value for insightName |
| 400 | Y800: Invalid value for input param in SUBSCRIPTION_CHANGED insight |
| 400 | Y800: Invalid value for threshold data in SUBSCRIPTION_CHANGED insight |
| 400 | Y800: Invalid value for CHANGE in SUBSCRIPTION_CHANGED insight Min = 0.01 and Max =10000.00 |
| 400 | Y800: Invalid value for CHANGE in SUBSCRIPTION_CHANGED insight Min = 0.00 and Max =500.00 |
| 400 | Y800: Invalid value for entityId; This id is either invalid or not supported for this insight. |
| 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 SUBSCRIPTION_CHANGED, modifying applicableEntity is not allowed |
| 400 | Y802: For insight SUBSCRIPTION_CHANGED, modifying triggerType is not allowed |
| 400 | Y802: For insight SUBSCRIPTION_CHANGED, modifying container is not allowed |
| 400 | Y802: For insight SUBSCRIPTION_CHANGED, modifying description is not allowed |
| 400 | Y802: Duplicate entityId entries within userConfiguration is not allowed |
| 400 | Y802: Specifying frequency attribute for SUBSCRIPTION_CHANGED insight is not allowed |
| 400 | Y802: Specifying duration attribute for SUBSCRIPTION_CHANGED 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 | 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 SUBSCRIPTION_CHANGED insight are - [ACCOUNT, VIEW] |
| 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 Subscription Changed 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=SUBSCRIPTION_CHANGED
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
{
"feed":[
{
"id":"60d43ad9e2974e643f862410",
"insightName":"SUBSCRIPTION_CHANGED",
"insightTitle":"Subscription Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"createdDate":"2021-06-24T07:57:09Z",
"subscription":[
{
"entityId":"60d439b2ad07551c02b06dc0",
"entityType":"VIEW",
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
],
"basicView":[
{
"id":"60d439b2ad07551c02b06dc0",
"name":"View 1",
"link":{
"entityName":"view",
"url":"/views/60d439b2ad07551c02b06dc0"
},
"basicAccount":[
{
"id":10254749,
"providerName":"Dag Site",
"accountName":"PDV Test Data-Event",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=10254749"
},
"basicTransaction":[
{
"id":12713276,
"amount":{
"amount":300.0,
"currency":"USD"
},
"date":"2021-05-26T00:00:00Z",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=12713276"
},
"categoryId":20,
"category":"Personal Care",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"original":"RECURRING PAYMENT AUTHORIZED ON 00/00 LA FITNESS 000-000-0000 CA S000000000000000 CARD 0000",
"simple":"RECURRING AUTHORIZED ON 00/00 LA FITNESS XX-0000 CA SXX0000 CARD 0000"
},
"sourceType":"AGGREGATED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"LA Fitness"
}
},
{
"id":12713723,
"amount":{
"amount":13.0,
"currency":"USD"
},
"date":"2021-06-24T00:00:00Z",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=12713723"
},
"categoryId":20,
"category":"Personal Care",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"original":"RECURRING PAYMENT AUTHORIZED ON 00/00 LA FITNESS 000-000-0000 CA S000000000000000 CARD 0000",
"simple":"RECURRING AUTHORIZED ON 00/00 LA FITNESS XX-0000 CA SXX0000 CARD 0000"
},
"sourceType":"AGGREGATED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"LA Fitness"
}
}
]
}
],
"changeValue":[
{
"changeType":"SUBSCRIPTION_AMOUNT",
"previousDate":"2021-05-26T00:00:00Z",
"previousAmount":{
"amount":"300.00",
"currency":"USD"
},
"currentDate":"2021-06-24T00:00:00Z",
"currentAmount":{
"amount":"13.00",
"currency":"USD"
},
"changeAmount":{
"amount":"-287.00",
"currency":"USD"
},
"changePercent":"-95.67"
}
]
}
]
},
{
"id":"60d43ad9e2974e643f86240d",
"insightName":"SUBSCRIPTION_CHANGED",
"insightTitle":"Subscription Changed",
"insightType":"OTHER",
"triggerType":"EVENT",
"createdDate":"2021-06-24T07:57:09Z",
"subscription":[
{
"entityId":"10254749",
"entityType":"ACCOUNT",
"threshold":[
{
"name":"CHANGE",
"value":"10",
"type":"AMOUNT"
},
{
"name":"CHANGE",
"value":"10",
"type":"PERCENT"
}
]
}
],
"basicAccount":[
{
"id":10254749,
"providerName":"Dag Site",
"accountName":"PDV Test Data-Event",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=10254749"
},
"basicTransaction":[
{
"id":12713279,
"amount":{
"amount":300.0,
"currency":"USD"
},
"date":"2021-05-26T00:00:00Z",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=12713279"
},
"categoryId":7,
"category":"Entertainment",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"original":"NetFlix Payment",
"simple":"NetFlix"
},
"sourceType":"AGGREGATED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"Netflix"
}
},
{
"id":12713725,
"amount":{
"amount":2999.0,
"currency":"USD"
},
"date":"2021-06-24T00:00:00Z",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=12713725"
},
"categoryId":7,
"category":"Entertainment",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"original":"NetFlix Payment",
"simple":"NetFlix"
},
"sourceType":"AGGREGATED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"Netflix"
}
}
],
"changeValue":[
{
"changeType":"SUBSCRIPTION_AMOUNT",
"previousDate":"2021-05-26T00:00:00Z",
"previousAmount":{
"amount":300.0,
"currency":"USD"
},
"currentDate":"2021-06-24T00:00:00Z",
"currentAmount":{
"amount":2999.0,
"currency":"USD"
},
"changeAmount":{
"amount":2699.0,
"currency":"USD"
},
"changePercent":899.67
}
]
}
]
}
]
}