New Subscription
Overview
The New Subscription insight is an event-triggered insight that alerts the user when the system identifies a new recurring subscription.
The insight for VIEW is generated only if the VIEW rule contains merchantType as 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 | NEW_SUBSCRIPTION |
|---|---|
| Applicable Entities | ACCOUNT, VIEW |
| Insight Type | OTHER |
| Trigger Type | EVENT |
| Supported Containers | BANK, CARD |
Use Cases
- Customer:
- User engagement
- User:
- Financial discipline - Keep track of spending.
Suggested Action
Use the following Predicted Cash Flow APIs to update/delete the predicted event based on user input:
Method and URLs:
PUT /predictedEvents/{predictedEventId}
DELETE /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 new subscription identified. The system identifies a recurring subscription provider based on the transaction history. Currently, 3 similar transactions are required to identify a series. However, if 2 consecutive instances of the identified series are missed, the series is disabled.
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 does not apply to this insight.
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": "NEW_SUBSCRIPTION",
"insightTitle": "New Subscription",
"insightType": "OTHER",
"triggerType": "EVENT",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight when a new recurring subscription is detected.",
"applicableEntity": [
"ACCOUNT",
"VIEW"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
},
{
"entityType": "VIEW",
"isSubscribed": true
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName": "NEW_SUBSCRIPTION",
"insightTitle": "New Subscription",
"insightType": "OTHER",
"triggerType": "EVENT",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight when a new recurring subscription is detected.",
"applicableEntity": [
"ACCOUNT",
"VIEW"
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
},
{
"entityType": "VIEW",
"isSubscribed": true
}
]
}
]
}
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 New Subscription 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) |
Sample Request:
{
"customerSubscription": [
{
"insightName": "NEW_SUBSCRIPTION",
"insightTitle": "New Title",
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
},
{
"entityType": "VIEW",
"isSubscribed": true
}
]
}
]
}
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 | Y802: For insight NEW_SUBSCRIPTION, modifying applicableEntity is not allowed |
| 400 | Y802: For insight NEW_SUBSCRIPTION, modifying triggerType is not allowed |
| 400 | Y802: For insight NEW_SUBSCRIPTION, modifying container is not allowed |
| 400 | Y802: For insight NEW_SUBSCRIPTION, 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 NEW_SUBSCRIPTION insight is not allowed |
| 400 | Y802: Specifying duration attribute for NEW_SUBSCRIPTION insight is not allowed |
| 400 | Y802: For NEW_SUBSCRIPTION insight passing threshold 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 NEW_SUBSCRIPTION 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=NEW_SUBSCRIPTION
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": "NEW_SUBSCRIPTION",
"insightTitle": "New Subscription",
"insightType": "OTHER",
"triggerType": "EVENT",
"containers": [
"BANK",
"CARD"
],
"description": "Generates an insight when a new recurring subscription is detected.",
"applicableEntity": [
"ACCOUNT",
"VIEW"
],
"userConfiguration": [
{
"entityType":"ACCOUNT",
"entityId": "10255809",
"isSubscribed": true
},
{
"entityType": "VIEW",
"isSubscribed": true
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
},
{
"entityType": "VIEW",
"isSubscribed": true
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName": "NEW_SUBSCRIPTION",
"insightTitle": "New Subscription",
"insightType": "OTHER",
"triggerType": "EVENT",
"container": [
"BANK",
"CARD"
],
"description": "Generates an insight when a new recurring subscription is detected.",
"applicableEntity": [
"ACCOUNT",
"VIEW"
],
"userConfiguration": [
{
"entityType":"ACCOUNT",
"entityId": "10255809",
"isSubscribed": true
},
{
"entityType": "VIEW",
"isSubscribed": true
}
],
"customerConfiguration": [
{
"entityType": "ACCOUNT",
"isSubscribed": true
},
{
"entityType": "VIEW",
"isSubscribed": true
}
]
}
]
}
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 subscription is generated. | Valid IDs for accounts or views belonging to the user. |
| isSubscribed | Subscribes or unsubscribes from the New Subscription insight. | true, false |
Sample Request:
{
"userSubscription":[
{
"insightName":"NEW_SUBSCRIPTION",
"userConfiguration":[
{
"entityType":"ACCOUNT",
"entityId": "10255809",
"isSubscribed":true
},
{
"entityType":"VIEW",
"isSubscribed":true
}
]
}
]
}
Error Messages:
| HTTP Status Code | Reason |
|---|---|
| 400 | Y806: Invalid input |
| 400 | Y800: Invalid value for insightName |
| 400 | Y800: Invalid value for input param in NEW_SUBSCRIPTION insight |
| 400 | Y800: Invalid value for entityId; This id is either invalid or not supported for this insight. |
| 400 | Y802: Duplicate entityId entries is not allowed |
| 400 | Y802: Modifying insightTitle using this API is not allowed |
| 400 | Y802: For insight NEW_SUBSCRIPTION, modifying applicableEntity is not allowed |
| 400 | Y802: For insight NEW_SUBSCRIPTION, modifying triggerType is not allowed |
| 400 | Y802: For insight NEW_SUBSCRIPTION, modifying container is not allowed |
| 400 | Y802: For insight NEW_SUBSCRIPTION, modifying description is not allowed |
| 400 | Y802: Duplicate entityId entries within userConfiguration is not allowed |
| 400 | Y802: Specifying frequency attribute for NEW_SUBSCRIPTION insight is not allowed |
| 400 | Y802: Specifying duration attribute for NEW_SUBSCRIPTION 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 | Y802: For NEW_SUBSCRIPTION insight passing threshold is not allowed |
| 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 | 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 NEW_SUBSCRIPTION 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 New Subscription 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=NEW_SUBSCRIPTION
Sample Response:
For more information about the attributes that are returned in the API response, refer to the Insights Data Model page.
{
"feed":[
{
"id":"64b669f081c0637dcd054a5e",
"insightName":"NEW_SUBSCRIPTION",
"insightTitle":"New Subscription",
"insightType":"OTHER",
"triggerType":"EVENT",
"createdDate":"2023-07-18T10:31:12Z",
"subscription":[
{
"entityId":"64b669eae12c981559d2db00",
"entityType":"VIEW"
}
],
"basicView":[
{
"id":"64b669eae12c981559d2db00",
"name":"Default View",
"link":{
"entityName":"view",
"url":"/views/64b669eae12c981559d2db00"
},
"basicAccount":[
{
"id":16400020,
"providerName":"Dag Site",
"accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
"accountStatus":"ACTIVE",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=16400020&status=ACTIVE"
},
"basicTransaction":[
{
"id":24060134,
"amount":{
"amount":300.00,
"currency":"USD"
},
"date":"2023-07-21",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=24060134&sourceType=PREDICTED"
},
"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":"LA Fitness"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"LA Fitness"
},
"basicPredictedEvent":{
"id":12440411,
"link":{
"entityName":"predictedEvent",
"url":"/predictedEvents/12440411"
},
"frequency":"MONTHLY"
}
},
{
"id":71267257,
"amount":{
"amount":300.00,
"currency":"USD"
},
"date":"2023-06-20",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=71267257"
},
"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":"LA Fitness"
},
"sourceType":"AGGREGATED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"LA Fitness"
}
}
]
}
]
}
]
},
{
"id":"64b669f081c0637dcd054a5a",
"insightName":"NEW_SUBSCRIPTION",
"insightTitle":"New Subscription",
"insightType":"OTHER",
"triggerType":"EVENT",
"createdDate":"2023-07-18T10:31:12Z",
"subscription":[
{
"entityId":"16400020",
"entityType":"ACCOUNT"
}
],
"basicAccount":[
{
"id":16400020,
"providerName":"Dag Site",
"accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
"accountStatus":"ACTIVE",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=16400020&status=ACTIVE"
},
"basicTransaction":[
{
"id":24060134,
"amount":{
"amount":300.00,
"currency":"USD"
},
"date":"2023-07-21",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=24060134&sourceType=PREDICTED"
},
"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":"LA Fitness"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"LA Fitness"
},
"basicPredictedEvent":{
"id":12440411,
"link":{
"entityName":"predictedEvent",
"url":"/predictedEvents/12440411"
},
"frequency":"MONTHLY"
}
},
{
"id":71267257,
"amount":{
"amount":300.00,
"currency":"USD"
},
"date":"2023-06-20",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=71267257"
},
"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":"LA Fitness"
},
"sourceType":"AGGREGATED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"LA Fitness"
}
}
]
}
]
}
]
}