Subscription Not Paid

Overview

The Subscription Not Paid insight is a schedule-trigger insight that reminds users when a recurring subscription is not paid for more than the configured number of days.

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: Subscription payment reconciliation depends on the user paying the subscription using the same account that is mapped to the predicted recurring subscription event. If the user pays the subscription using a different account, the insight will still get triggered.

Following are the additional details for the insight:

Insight Name	SUBSCRIPTION_NOT_PAID
Applicable Entities	ACCOUNT, VIEW
Insight Type	OTHER
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. In case the user already paid using a different account, hide the insight instance. If the subscription was cancelled by the user, delete the event so that further notifications are not generated.

Use the following predicted cash flow APIs to delete the predicted event based on user input:

DELETE /predictedEvents/{predictedEventId}

Duplicate Insight Checks

To prevent the same insight from generating repeatedly, the insight is generated once per frequency cycle for each of the applicable transaction ID per entity ID.

The following is the applicable frequency 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.

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 when the user has to be alerted. The insight is generated for the specific predicted subscription transaction If the predicted transaction has not been reconciled for the configured number of days in DELAY.

Threshold Name: DELAY
Data Type: DAYS
Range Allowed: 1 <= Number of Days <= 15
Default: 3

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":"SUBSCRIPTION_NOT_PAID",
         "insightTitle":"Subscription Not Paid",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "containers":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight if a recurring subscription has not been paid for more than a configured number of days.",
         "applicableEntity":[
            "ACCOUNT",
            "VIEW"
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            },
            {
               "entityType":"VIEW",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            }
         ]
      }
   ]
}

Api-Version 2 Response

{
   "customerSubscription":[
      {
         "insightName":"SUBSCRIPTION_NOT_PAID",
         "insightTitle":"Subscription Not Paid",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "container":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight if a recurring subscription has not been paid for more than a configured number of days.",
         "applicableEntity":[
            "ACCOUNT",
            "VIEW"
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            },
            {
               "entityType":"VIEW",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "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 Subscription Not Paid 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 value (DELAY) for generating the Subscription Not Paid insight can be changed.	Any number between 1 and 15.

Sample Request:

{
   "customerSubscription":[
      {
         "insightName":"SUBSCRIPTION_NOT_PAID",
         "insightTitle":"Subscription Not Paid",
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            },
            {
               "entityType":"VIEW",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "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 DELAY in SUBSCRIPTION_NOT_PAID insight Min =1 and Max = 15
400	Y802: For insight SUBSCRIPTION_NOT_PAID, modifying applicableEntity is not allowed
400	Y802: For insight SUBSCRIPTION_NOT_PAID, modifying triggerType is not allowed
400	Y802: For insight SUBSCRIPTION_NOT_PAID, modifying container is not allowed
400	Y802: For insight SUBSCRIPTION_NOT_PAID, modifying description is not allowed
400	Y802: For insight SUBSCRIPTION_NOT_PAID, modifying frequency is not allowed
400	Y802: Specifying duration attribute for SUBSCRIPTION_NOT_PAID 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 SUBSCRIPTION_NOT_PAID insight are - [ACCOUNT, VIEW]
400	Y813: Invalid request. The entire object within threshold should be provided
400	Y802: For SUBSCRIPTION_NOT_PAID insight, {Invalid String} inside the threshold is either repeated or not allowed
400	Y802: For SUBSCRIPTION_NOT_PAID 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=SUBSCRIPTION_NOT_PAID

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_NOT_PAID",
         "insightTitle":"Subscription Not Paid",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "containers":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight if a recurring subscription has not been paid for more than a configured number of days.",
         "applicableEntity":[
            "ACCOUNT",
            "VIEW"
         ],
         "userConfiguration":[
            {
               "entityType": "ACCOUNT",
               "entityId": "10255809",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            },
            {
               "entityType":"VIEW",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            },
            {
               "entityType":"VIEW",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            }
         ]
      }
   ]
}

Api-Version 2 Response

{
   "userSubscription":[
      {
         "insightName":"SUBSCRIPTION_NOT_PAID",
         "insightTitle":"Subscription Not Paid",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "container":[
            "BANK",
            "CARD"
         ],
         "description":"Generates an insight if a recurring subscription has not been paid for more than a configured number of days.",
         "applicableEntity":[
            "ACCOUNT",
            "VIEW"
         ],
         "userConfiguration":[
            {
               "entityType": "ACCOUNT",
               "entityId": "10255809",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            },
            {
               "entityType":"VIEW",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            }
         ],
         "customerConfiguration":[
            {
               "entityType":"ACCOUNT",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            },
            {
               "entityType":"VIEW",
               "isSubscribed":true,
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "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 Subscription Not Paid insight.	true, false
threshold	The threshold value (DELAY) for generating the Subscription Not Paid insight can be changed.	Any number between 1 to 15.

Sample Request:

{
   "userSubscription":[
      {
         "insightName":"SUBSCRIPTION_NOT_PAID",
         "userConfiguration":[
            {
               "entityType": "ACCOUNT",
               "entityId": "10255809",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            },
            {
               "entityType":"VIEW",
               "isSubscribed":true,
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "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 SUBSCRIPTION_NOT_PAID insight
400	Y802: For insight SUBSCRIPTION_NOT_PAID, modifying frequency is not allowed
400	Y802: Specifying duration attribute for SUBSCRIPTION_NOT_PAID 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 DELAY in SUBSCRIPTION_NOT_PAID insight Min =1 and Max = 15
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 SUBSCRIPTION_NOT_PAID, modifying applicableEntity is not allowed
400	Y802: For insight SUBSCRIPTION_NOT_PAID, modifying triggerType is not allowed
400	Y802: For insight SUBSCRIPTION_NOT_PAID, modifying container is not allowed
400	Y802: For insight SUBSCRIPTION_NOT_PAID, 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 SUBSCRIPTION_NOT_PAID insight are - [ACCOUNT, VIEW]
400	Y800: Invalid value for threshold data in SUBSCRIPTION_NOT_PAID 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 Subscription Not Paid 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_NOT_PAID

Sample Response:

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

{
   "feed":[
      {
         "id":"60dabca2a7683b195407d1cc",
         "insightName":"SUBSCRIPTION_NOT_PAID",
         "insightTitle":"Subscription Not Paid",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-06-29T06:24:34Z",
         "subscription":[
            {
               "entityId":"60dab88afc778d5873a05a39",
               "entityType":"VIEW",
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            }
         ],
         "basicView":[
            {
               "id":"60dab88afc778d5873a05a39",
               "name":"Views",
               "link":{
                  "entityName":"view",
                  "url":"/views/60dab88afc778d5873a05a39"
               },
               "basicAccount":[
                  {
                     "id":10254559,
                     "providerName":"Dag Site",
                     "accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
                     "accountType":"CHECKING",
                     "isAsset":true,
                     "container":"bank",
                     "link":{
                        "entityName":"account",
                        "url":"/accounts?accountId=10254559"
                     },
                     "basicTransaction":[
                        {
                           "id":15369673,
                           "amount":{
                              "amount":300.0,
                              "currency":"USD"
                           },
                           "date":"2021-06-26",
                           "link":{
                              "entityName":"transaction",
                              "url":"/derived/transactions?transactionId=15369673"
                           },
                           "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":"60dab8fea7683b195407d1bd",
         "insightName":"SUBSCRIPTION_NOT_PAID",
         "insightTitle":"Subscription Not Paid",
         "insightType":"OTHER",
         "triggerType":"SCHEDULE",
         "createdDate":"2021-06-29T06:09:01Z",
         "subscription":[
            {
               "entityId":"10254559",
               "entityType":"ACCOUNT",
               "frequency":"DAILY",
               "threshold":[
                  {
                     "name":"DELAY",
                     "value":"3",
                     "type":"DAYS"
                  }
               ]
            }
         ],
         "basicAccount":[
            {
               "id":10254559,
               "providerName":"Dag Site",
               "accountName":"PDV_Test_Data-Long_Tenure_Recurring_Payments",
               "accountType":"CHECKING",
               "isAsset":true,
               "container":"bank",
               "link":{
                  "entityName":"account",
                  "url":"/accounts?accountId=10254559"
               },
               "basicTransaction":[
                  {
                     "id":15369673,
                     "amount":{
                        "amount":300.0,
                        "currency":"USD"
                     },
                     "date":"2021-06-26",
                     "link":{
                        "entityName":"transaction",
                        "url":"/derived/transactions?transactionId=15369673"
                     },
                     "categoryId":20,
                     "category":"Personal Care",
                     "categoryType":"EXPENSE",
                     "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"
                     }
                  }
               ]
            }
         ]
      }
   ]
}