Missed Subscription
Overview
The Missed Subscriptions insight is a schedule-trigger insight that informs the users about any missed payment against a subscription for the given duration across all the bank and cards aggregated by the user.
The Predicted Cash Flow feature must be enabled as a pre-requisite for this insight.
Following are the additional details for the insight:
| Insight Name | MISSED_SUBSCRIPTIONS |
|---|---|
| Applicable Entity | ACCOUNT |
| Insight Type | AGGREGATE |
| Trigger Type | SCHEDULE |
| Supported Containers | BANK, CARD |
Use Cases
- Customer:
- User engagement
- User:
- Financial discipline - Pay subscriptions on time and avoid late fees.
Suggested Action
Suggest the user to pay the subscription. If the user already paid using a different account, hide the insight.
Duplicate Insight Checks
To prevent the same insight from generating repeatedly, the insight is generated only once per scheduled frequency for a user.
The following is the applicable frequency for this insight:
| Frequency | Description |
|---|---|
| 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:
|
Insight Dynamic Trigger (On-Demand Evaluation)
The 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 when the user has to be alerted about the missed subscriptions.
- Threshold Name: TOP
- Data Type: NUMBER
- Range Allowed: 1 <= TOP <= 100
- Default: 10
Note: Depending on the customer segment and account, the 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 MID_MONTHLY and the default duration for the insight is LAST_MONTH.
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":"MISSED_SUBSCRIPTIONS",
"insightTitle":"Missed Subscriptions",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"containers":[
"BANK",
"CARD"
],
"description":"Generates an insight to inform the user about any missed payment against a subscription for the given duration.",
"applicableEntity":[
"ACCOUNT"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_MONTH",
"threshold":[
{
"name":"TOP",
"value":"10",
"type":"NUMBER"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"customerSubscription":[
{
"insightName":"MISSED_SUBSCRIPTIONS",
"insightTitle":"Missed Subscriptions",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"container":[
"BANK",
"CARD"
],
"description":"Generates an insight to inform the user about any missed payment against a subscription for the given duration.",
"applicableEntity":[
"ACCOUNT"
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_MONTH",
"threshold":[
{
"name":"TOP",
"value":"10",
"type":"NUMBER"
}
]
}
]
}
]
}
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 Missed 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) |
| threshold | The threshold (TOP) can be modified. | Any number between 1 to 100. |
Sample Request:
{
"customerSubscription":[
{
"insightName":"MISSED_SUBSCRIPTIONS",
"insightTitle":"Missed Subscriptions",
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"TOP",
"value":"10",
"type":"NUMBER"
}
]
}
]
}
]
}
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 TOP in MISSED_SUBSCRIPTIONS insight Min = 1 and Max = 100 |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, modifying applicableEntity is not allowed |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, modifying triggerType is not allowed |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, modifying container is not allowed |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, 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: For insight MISSED_SUBSCRIPTIONS, modifying frequency is not allowed |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, modifying duration 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 MISSED_SUBSCRIPTIONS insight are - [ACCOUNT] |
| 400 | Y802: For MISSED_SUBSCRIPTIONS insight, {Invalid String} inside the threshold is either repeated or not allowed |
| 400 | Y802: For MISSED_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.
The entityId filter does not apply to 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 |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /insights/configs/userSubscriptions?insightName=MISSED_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":"MISSED_SUBSCRIPTIONS",
"insightTitle":"Missed Subscriptions",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"containers":[
"BANK",
"CARD"
],
"description":"Generates an insight to inform the user about any missed payment against a subscription for the given duration.",
"applicableEntity":[
"ACCOUNT"
],
"userConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_MONTH",
"threshold":[
{
"name":"TOP",
"value":"10",
"type":"NUMBER"
}
]
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_MONTH",
"threshold":[
{
"name":"TOP",
"value":"10",
"type":"NUMBER"
}
]
}
]
}
]
}
- Api-Version 2 Response
{
"userSubscription":[
{
"insightName":"MISSED_SUBSCRIPTIONS",
"insightTitle":"Missed Subscriptions",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"container":[
"BANK",
"CARD"
],
"description":"Generates an insight to inform the user about any missed payment against a subscription for the given duration.",
"applicableEntity":[
"ACCOUNT"
],
"userConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_MONTH",
"threshold":[
{
"name":"TOP",
"value":"10",
"type":"NUMBER"
}
]
}
],
"customerConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"frequency":"MID_MONTHLY",
"duration":"LAST_MONTH",
"threshold":[
{
"name":"TOP",
"value":"10",
"type":"NUMBER"
}
]
}
]
}
]
}
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 |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Editable Parameters:
| Editable Attributes | Impact | Allowed Values |
|---|---|---|
| isSubscribed | Subscribes or unsubscribes from the Missed Subscriptions insight. | true, false |
| threshold | The threshold (TOP) can be modified. | Any number between 1 to 100. |
Sample Request:
{
"userSubscription":[
{
"insightName":"MISSED_SUBSCRIPTIONS",
"userConfiguration":[
{
"entityType":"ACCOUNT",
"isSubscribed":true,
"threshold":[
{
"name":"TOP",
"value":"10",
"type":"NUMBER"
}
]
}
]
}
]
}
Error Messages:
| HTTP Status Code | Reason |
|---|---|
| 400 | Y806: Invalid input |
| 400 | Y800: Invalid value for insightName |
| 400 | Y800: Invalid value for input param in MISSED_SUBSCRIPTIONS insight |
| 400 | Y802: Modifying insightTitle using this API is not allowed |
| 400 | Y813: Invalid request. The entire object within threshold should be provided |
| 400 | Y800: Invalid value for threshold data in MISSED_SUBSCRIPTIONS insight |
| 400 | Y800: Invalid value for TOP in MISSED_SUBSCRIPTIONS insight Min =1 and Max = 100 |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, modifying applicableEntity is not allowed |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, modifying triggerType is not allowed |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, modifying container is not allowed |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, modifying description is not allowed |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, modifying frequency is not allowed |
| 400 | Y802: For insight MISSED_SUBSCRIPTIONS, modifying duration 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 | 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 | Y802: For insight MISSED_SUBSCRIPTIONS, configurations at an entityId level are not allowed |
| 400 | Y800: Invalid value for entityType. Supported entityType for MISSED_SUBSCRIPTIONS 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 Missed Subscriptions insight can be specifically requested.
The entityId filter does not apply to 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 |
3.0 |
|
2.1 |
||
2 |
||
Cobrand-Name |
{Name of the Customer} |
|
Sample Request:
GET /insights/feed?insightName=MISSED_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":"620d24404a53327082fced6f",
"insightName":"MISSED_SUBSCRIPTIONS",
"insightTitle":"Missed Subscriptions 123",
"insightType":"AGGREGATE",
"triggerType":"SCHEDULE",
"createdDate":"2022-02-16T16:19:55Z",
"subscription":[
{
"entityType":"ACCOUNT",
"frequency":"MID_MONTHLY",
"duration":"LAST_MONTH",
"threshold":[
{
"name":"TOP",
"value":"30",
"type":"NUMBER"
}
]
}
],
"basicAccount":[
{
"id":14698129,
"providerName":"Dag Site",
"accountName":"EntertainmentSubscriptions",
"accountStatus":"ACTIVE",
"accountType":"SAVINGS",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=14698129"
},
"basicTransaction":[
{
"id":21250893,
"amount":{
"amount":200.0,
"currency":"USD"
},
"date":"2022-01-26",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=21250893&sourceType=PREDICTED"
},
"categoryId":7,
"category":"Entertainment",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"NetFlix Payment",
"consumer":"Netflix"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"Netflix"
}
}
]
},
{
"id":14698130,
"providerName":"Dag Site",
"accountName":"NewsSubscriptions",
"accountStatus":"ACTIVE",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=14698130"
},
"basicTransaction":[
{
"id":21250900,
"amount":{
"amount":200.0,
"currency":"USD"
},
"date":"2022-01-25",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=21250900&sourceType=PREDICTED"
},
"categoryId":108,
"category":"Dues and Subscriptions",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"usnews.com Subscription Monthly 07/20",
"consumer":"usnews.com Subscription Monthly"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION"
},
{
"id":21250858,
"amount":{
"amount":14.0,
"currency":"USD"
},
"date":"2022-01-25",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=21250858&sourceType=PREDICTED"
},
"categoryId":7,
"category":"Entertainment",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"Sling TV subscription",
"consumer":"Sling TV"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"Sling TV"
}
}
]
},
{
"id":14698131,
"providerName":"Dag Site",
"accountName":"OtherSubscriptions",
"accountStatus":"ACTIVE",
"accountType":"CHECKING",
"isAsset":true,
"container":"bank",
"link":{
"entityName":"account",
"url":"/accounts?accountId=14698131"
},
"basicTransaction":[
{
"id":21250872,
"amount":{
"amount":200.0,
"currency":"USD"
},
"date":"2022-01-24",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=21250872&sourceType=PREDICTED"
},
"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":"LA Fitness"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"LA Fitness"
}
},
{
"id":21250865,
"amount":{
"amount":14.0,
"currency":"USD"
},
"date":"2022-01-24",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=21250865&sourceType=PREDICTED"
},
"categoryId":7,
"category":"Entertainment",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"hulu Plus subscription weekly 3/20",
"consumer":"Hulu"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"Hulu"
}
},
{
"id":21250851,
"amount":{
"amount":200.0,
"currency":"USD"
},
"date":"2022-01-24",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=21250851&sourceType=PREDICTED"
},
"categoryId":7,
"category":"Entertainment",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"RECURRING PAYMENT AUTHORIZED ON 00/00 Disney Plus 000-000-0000 CA S000000000000000 CARD 0000",
"consumer":"Disney Plus"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"Disney Plus"
}
}
]
},
{
"id":14698133,
"providerName":"Dag Site",
"accountName":"CardSubscriptions",
"accountStatus":"ACTIVE",
"accountType":"CREDIT",
"isAsset":false,
"container":"creditCard",
"link":{
"entityName":"account",
"url":"/accounts?accountId=14698133"
},
"basicTransaction":[
{
"id":21250942,
"amount":{
"amount":200.0,
"currency":"USD"
},
"date":"2022-01-04",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=21250942&sourceType=PREDICTED"
},
"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":"LA Fitness"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"LA Fitness"
}
},
{
"id":21250928,
"amount":{
"amount":14.0,
"currency":"USD"
},
"date":"2022-01-04",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=21250928&sourceType=PREDICTED"
},
"categoryId":44,
"category":"General Merchandise",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"FabFitFun subscription",
"consumer":"FabFitfun"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION",
"basicMerchant":{
"name":"FabFitfun"
}
},
{
"id":21250921,
"amount":{
"amount":200.0,
"currency":"USD"
},
"date":"2022-01-04",
"link":{
"entityName":"transaction",
"url":"/derived/transactions?transactionId=21250921&sourceType=PREDICTED"
},
"categoryId":108,
"category":"Dues and Subscriptions",
"categoryType":"EXPENSE",
"baseType":"DEBIT",
"description":{
"simple":"RECURRING PAYMENT AUTHORIZED ON 00/00 paramount plus Plus 000-000-0000 CA S000000000000000 CARD 0000",
"consumer":"RECURRING AUTHORIZED ON 00/00 paramount plus Plus XX-0000 CA SXX0000 CARD 0000"
},
"sourceType":"SYSTEM_PREDICTED",
"merchantType":"SUBSCRIPTION"
}
]
}
]
}
]
}