Skip to main content

Subscription Notifications

You can receive notifications whenever your subscription status changes.

History of changes

Change tagChange descriptionChange date
FRQ-410The new type of notification "Subscription Payment Method Replayability Changed" is added12.12.2025
IAP-27695paymentMethodName is added into Subscription Payment Method Changed notification15.12.2025

Event list

  • Subscription Created
  • Subscription Suspended
  • Subscription Reactivated
  • Subscription Canceled
  • Subscription Discount Plan Updated
  • Subscription Expiration Date Updated - triggered only when the date is shifted outside of the normal renewal process
  • Subscription Unpaid - triggered with the email reminder about the unpaid subscription, which depends on the subscription model
  • Subscription Expired - sent when the grace period ends
  • Payment Method Changed

List of fields

NameDescriptionR/O
subjectsubscriptionR
typeDepending on the event:
• reactivated
• suspended
• canceled
see notifications with subject=subscription
R
objectIdsubscriptonId: afe09ab2-25d0-4fdb-857e-dc22ff21ce8fR
eventDate2025-07-25T11:30:03Z
subscription {object}Subscription details objectR
subscription.idSubscription UUIDR
subscription.createDateCreation date in ISO 8601 format ex. 2025-07-25T11:30:03ZR
subscription.modelIdSubscription model, ex: NEXWAY_1YR
subscription.nameSubscription name, usually taken from the product Kaspersky Endpoint Security CloudO
subscription.storeId36f48867-d6ca-42d3-bf55-5f54a6740803R
subscription.lifecycle {object}Lifecycle details objectR
subscription.lifecycle.id9191920 DeprecatedO
subscription.lifecycle.generationNumber of term intR
subscription.products [{object}]Subscription currently may have only one productR
subscription.products[].idProduct UUIDR
subscription.products[].lineItemIdOrder lineItem UUIDR
subscirption.lifecycle.anniversaryDateAnniversary date (or the date until the subscription is paid)R
subscirption.lifecycle.statusActive, Suspended, Dunning, Canceled, ExpiredR
subscirption.discountPlan {object}Discount plan associated with the subscriptionO
subscirption.discountPlan.tagR
subscirption.discountPlan.startingStepR
subscription.endUserIdEnduser UUIDR

Example

{
"subject": "subscription",
"type": "created",
"objectId": "c0a47254-fb78-4859-8954-d98ff5fb7730",
"eventDate": "2020-09-07T13:46:57Z",
"subscription": {
"id": "c0a47254-fb78-4859-8954-d98ff5fb7730",
"createDate":"1595918226381",
"modelId": "NEXWAY_1M",
"name": "Nexway Secure Connection",
"lifecycle": {
"id": "6862801",
"anniversaryDate" : "2026-04-09T15:30:38Z"
},
"products":[
{
"id": "d4b35678-94ec-4e8c-acd5-d758a71ede7f",
"lineItemId": "c5ad58a0-6f41-47cf-9ecc-ab57b034c25e"
}
]
}
}

Subscription Discount Plan Updated

This notification will be sent when the subscription discount plan is updated.

Payload

NameDescriptionR/O
subscription.idSubscription unique identifierR
subjectsubscriptionR
typediscount plan updatedR
objectIdUUID of an object (subscription ID in this case)R
eventDate2025-09-29T07:34:06ZR
subscription.discountPlan {object}Node with subscription plan is added / updated for a given subscriptionR
subscription.discountPlan.tagSubscription discount plan tag is added / chagnedR
subscription.discountPlan.nextDiscountStepThe number of next discount plan step will be used for subscription discounting. Calculates by formula nextDiscountStep=startingStep + generation + 1R

Example

{
"subject" : "subscription",
"type" : "discount plan updated",
"objectId" : "d888ff3b-0381-4b35-9cbe-f9c73666524f",
"eventDate" : "2025-01-28T08:58:42Z",
"subscription" : {
"id" : "d888ff3b-0381-4b35-9cbe-f9c73666524f",
"discountPlan": {
"tag": "tag"
"nextDiscountStep": 1
}
}
}

Subscription Payment Method Changed

This notification is sent when the end-user changes subscription payment method.

NameDescriptionR / O
subjectendUserR
typesubscriptionPaymentMethodUpdatedR
objectIdUUID of an object (enduser ID in this case)R
eventDate2025-09-29T07:34:06ZR
enduser {object}R
enduser.idpayment method UUID: 8d2eaaf6-9eba-4400-9927-516672d4693bR
enduser.subscriptionIdsubscription idR
enduser.paymentMethodpayment method type, f.e. creditCardO
enduser.expirationDate11/2028O
enduser.paymentMethodNameIAP-27695 - The payment method name, f.e. visaO

FRQ-410

Subscription Payment Method Replayability Changed

This notification is sent when:

1. New subscription is created

Condition to check:

  • payment method is NOT attached to the subscription in the endUser’s wallet
    How to reflect it in the notification:

    • paymentMethodNonReplayable=true
    • warningReason=paymentMethodIsNotAttachedToSubscription
  • payment method will expire sooner than the planned billing date
    How to reflect it in the notification:

    • paymentMethodNonReplayable=true
    • warningReason=paymentMethodExpiresSoon

2. Subscription Payment Method Change Within Wallet

Condition to check:

  • The newly attached payment method has an expiration date that precedes the next scheduled billing date.

How to reflect it in the notification:

  • paymentMethodNonReplayable=true
  • warningReason=paymentMethodExpiresSoon

3. Payment Method Detached from Subscription in Wallet

Condition to check:

  • The user actively removes the payment method that was previously associated with the subscription within their wallet interface.

How to reflect it in the notification:

  • paymentMethodNonReplayable=true
  • warningReason=paymentMethodIsNotAttachedToSubscription

4. Payment Method Non-Replayable Flag Set True Directly

Condition to check:

  • paymentMethodIsNoLongerReplayable=true

How to reflect it in the notification:

  • paymentMethodNonReplayable=true
  • warningReason=paymentMethodIsNoLongerReplayable
  • reasonDescription={the text from subscription-manager’s field if any}

5. Payment Method Non-Replayable Flag is changed to False

Condition to check:

  • paymentMethodIsNoLongerReplayable=false

How to reflect it in the notification:

  • paymentMethodNonReplayable=true
  • warningReason - should be skipped in this case
  • reasonDescription={the text from subscription-manager’s field if any}

6. Subscription Renewal Date Changed

Condition to check:

  • payment method will expire sooner than planning billing date

How to reflect it in the notification:

  • paymentMethodNonReplayable=true
  • warningReason=paymentMethodExpiresSoon

The payload is following:

NameDescriptionR / O
subjectsubscriptionR
typesubscriptionPaymentMethodReplayabilityChangedR
objectIdUUID of an object (subscription id in this case)R
eventDate2025-09-29T07:34:06ZR
paymentMethod {object}Object describing payment method attached to subscriptionO
paymentMethod.typePaymentMethodType form endUser’s wallet, f.e. “creditCard”O
paymentMethod.paymentMethodNametype from endUser's wallet, f.e. "visa", "pix"O
paymentMethod.expirationDateExpiration date of payment method stored in endUser’s wallet, f.e. “06/2026”O
paymentMethodNonReplayablebooleanR
warningReasonPossible values:
paymentMethodExpiresSoon
paymentMethodIsNotAttachedToSubscription
paymentMethodIsNoLongerReplayable
O
reasonDescriptionTextual description of a reason of non-repayability, should be taken from sub-managerO