Important
You can filter the content on this page by subscription management version. For more information, see Subscription Management 1.0 and 2.0. If you are unsure which version you are on, contact Client Experience.
Cleverbridge offers different types of notifications. The notifications are based on events that in turn are configured to trigger automatic notifications. The notification type is used as the file name and in the meta object under type in the JSON notification or as the root element of the XML notification, respectively. The table below lists each notification type, along with its corresponding email prefix, event, and description.
Note
The only difference for Notification Types between Subscription Management 1.0 and 2.0 is that 2.0 includes the event "Subscription renewal type changed". If the dropdown toggle above is set to 2.0, the event is highlighted in yellow for better findability.
| Event | Notification Type | Description |
Prefix |
|---|---|---|---|
Awaiting offline payment Offline payment stands for a group of payment options. With the order confirmation, the customer receives a link with information on how to make the payment. Ordered products are delivered as soon as Cleverbridge receives a payment confirmation from the payment provider. |
NewOfflinePaymentPurchaseNotification |
A new order has been placed using an offline payment method, such as wire transfer, money order, or check. | [WOF] |
| Paid |
PaidOrderNotification |
A customer has successfully executed the payment for the placed order. This notification is sent when the payment is received for online and offline payments alike. | [PAY] |
| Purchase order |
NewPurchaseOrderNotification |
A customer has placed a new order by using an invoicing method. This order is fulfilled prior to the reception of the payment. | [WPO] |
| Registration |
RegistrationNotification |
A customer has registered for a product or a service, and a free order has been created. | [REG] |
| Refunded |
RefundNotification |
A full refund has been issued for the purchase. The total gross amount of the order or the service has been paid back to the customer. | [REF] |
| Partially refunded |
PartialRefundNotification |
A partial refund has been issued for the purchase. A portion of the total amount of an order or service has been paid back to the customer. | [REF] |
| Chargeback |
ChargebackNotification |
Cleverbridge received information from our credit card processor that a customer is disputing a purchase and has initiated a chargeback. NoteThere are two types of notifications that relate to chargebacks: To receive both notifications, you must set up two separate notifications in the Cleverbridge platform under Tools > Add Notifications. In the first notification, select Chargeback under Notification Events. In the second notification, select Chargeback information request under Notification Events. If you create one notification with both of these events, you will not receive the |
[CHB] |
| Payment declined |
OnlinePaymentDeclined |
A payment for an initial order or a subscription renewal has been declined. | [DEC] |
| Returned direct debit |
ReturnDirectDebitNotification |
A return of a direct debit has been issued for the amount paid using the direct debit payment method. | [CHB] |
| Test order |
PaidOrderNotification |
A test order has been placed in the Cleverbridge system using a test credit card. | [PAY] |
| New quote |
QuoteNotification |
A customer has requested a price quote for your product. | [QUO] |
| Awaiting release |
AwaitingNotification |
An order has been placed and you need to accept it before it can be processed. | [AWR] |
|
Customer contact data changed |
CustomerContactDataChangedNotification |
The customer's data has been updated for a specific order. New customer data is sent in this notification. | [CDC] |
| Subscription on grace |
RecurringBillingOnGraceNotification |
The payment for a subscription is due but could not be processed with the available payment details. The customer must update the payment information to process the renewal or the subscription will be deactivated. | [RCH] |
| Subscription on hold |
RecurringBillingOnHoldNotification |
The granted grace period has ended without payment received for the subscription. The customer must execute payment in the next few days or face the risk of subscription deactivation. | [RCH] |
| Subscription reinstated |
RecurringBillingReinstatedNotification |
The subscription has been reactivated and the customer is expected to execute payment on the next billing date. | [RCA] |
| Subscription deactivated |
RecurringBillingCanceledNotification |
The subscription has been canceled, either online by the customer or by a customer support specialist. As a result, the customer will not be re-billed on the next billing date. TipWhen you receive the |
[RCC] |
| Subscription reminder charge |
SubscriptionReminderChargeNotification |
A reminder that the subscription renewal is approaching for online payments. | [RCR] |
| Subscription reminder payment expired |
SubscriptionReminderPayOptExpNotification |
The payment for a subscription renewal is due but the credit or debit card used in previous transactions will expire before the next billing date. NoteBe sure to send a change payment link to the customer in order for them to update the data before the payment due date. |
[RPE] |
| Subscription reminder offline payment |
SubscriptionReminderOfflinePayNotification |
This is a reminder for an upcoming renewal that is limited to orders placed with offline payment methods. The default setting is seven days prior to the renewal date. | [ROP] |
| Subscription profile data changed |
CustomerProfileUpdateNotification |
The profile data for a subscription was modified. For example, payment details. | [CPU] |
| Subscription billing date extended |
SubscriptionBillingDateExtendedNotification |
The billing date for a customer's subscription has been changed or extended. | [BDE] |
| New affiliate |
NewAffiliateSignup |
A new affiliate has signed up through the Cleverbridge platform and has to be reviewed prior to being accepted. | [NAF] |
| New partner |
NewPartnerSignup |
A new partner has signed up through the Cleverbridge platform and has to be reviewed prior to being accepted. | [NPA] |
| Error |
ErrorNotification NoteThe data you receive depends on the type of error that occurs. For example, if a customer successfully pays for a product, but an error occurs during the license key generation, then Cleverbridge sends an email notification with the following subject line: "[ERR] #123456789: Error creating license key for Cleverbridge". However, since the transaction was successful, a |
An error occurred during one of the following scenarios:
NoteSee the Error Log in the Cleverbridge platform in order to find out if further action is required on your part. |
[ERR] |
| Subscription renewal type changed |
SubscriptionRenewalTypeChangedNotification |
A customer changed the subscription renewal type (automatic or manual). | [PAY] |
| Chargeback information request |
ChargebackInformationRequestNotification |
Cleverbridge has decided to fight a chargeback request. Therefore, we need you to provide us with additional information to help us fight it. NoteThis notification is delivered via email. Be sure to set up a Contact as the email recipient who can provide Cleverbridge with the information that we require. For more information about email notifications and contacts, see Manage Notifications. NoteThere are two types of notifications relating to chargebacks: To receive both notifications, you must set up two separate notifications in the Cleverbridge platform under Tools > Add Notifications. In the first notification, select Chargeback under Notification Events. In the second notification, select Chargeback information request under Notification Events. If you create one notification with both of these events, you will not receive the |
[CIR] |
| Awaiting release for purchase order |
AwaitingReleaseForPurchaseOrderNotification |
A customer has placed a purchase order and must now confirm it by fax, letter, or email. Following the confirmation, either Cleverbridge or the client must approve the order in the Cleverbridge platform. |
[APO] |
| VAT refunded | VatRefundNotification View JSON and XML examples |
A VAT, GST, or sales tax refund has been issued. A business customer contacted our customer support team and requested a refund of the tax paid on an order. After checking the necessary information, such as the VAT identification number, a customer support specialist processed the refund. | [REF] |
| Secure 3D enrolled | Secure3DEnrolledNotification View JSON and XML examples |
A purchase or recurring payment requires strong customer authentication (SCA) and the customer has not yet authenticated the payment with their bank. Cleverbridge will process the purchase when the customer has successfully completed the authentication process. The notification allows you to track the impact of SCA on your business and launch targeted marketing campaigns. | [SCA] |