Notification Types

Important

You can filter the content on this page by subscription management version. For more information, see Subscription Management 1.0 and 2.0.

Show resources for:

cleverbridge offers different types of notifications. The notifications are based on events that are in turn configured to trigger automatic notification. The notification type is used as the file name and as the root element of the XML notification. The table below lists each notification type, along with its corresponding email prefix, event, and description.

Event Notification Type Description

Email

Prefix

Awaiting offline paymentClosedOffline 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

View JSON and XML examples

A new order has been placed using an offline payment method, such as wire transfer, money order, or check. [WOF]
Paid

PaidOrderNotification

View JSON and XML examples

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

View JSON and XML examples

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

View JSON and XML examples

A customer has registered for a product or a service and a free order has been created. [REG]
Refunded

RefundNotification

View JSON and XML examples

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

View JSON and XML examples

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

View JSON and XML examples

cleverbridge received information from our credit card processor that a customer is disputing a purchase and has initiated a chargeback.

Note

There are two types of notifications that relate to chargebacks:

To receive both notifications, you must set up two separate notifications in the Commerce Assistant under Tools > Add Notifications. In the first notification, you should select Chargeback under Notification Events. In the second notification, you should select Chargeback information request under Notification Events. If you create one notification with both of these events, you will not receive the ChargebackInformationRequestNotification.

[CHB]
Payment declined

OnlinePaymentDeclined

View JSON and XML examples

A payment for an initial order or a subscription renewal has been declined. [DEC]
Returned direct debit

ReturnDirectDebitNotification

View JSON and XML examples

A return of a direct debit has been issued for the amount paid using the direct debit payment method. [CHB]
Test order

PaidOrderNotification

View JSON and XML examples

A test order has been placed in the cleverbridge system using a test credit card. [PAY]
New quote

QuoteNotification

View JSON and XML examples

A customer has requested a price quote for your product. [QUO]
Awaiting release

AwaitingNotification

View JSON and XML examples

An order has been placed that needs to be accepted by you before it can be processed. [AWR]

Customer contact data changed

CustomerContactDataChangedNotification

View JSON and XML examples

The customer's data has been updated for a specific order. New customer data is sent in this notification. [CDC]
Subscription on hold

RecurringBillingOnHoldNotification

View JSON and XML examples

The granted grace period has ended without the payment being received for the subscription. The customer must execute payment in the next few days or face the risk of subscription deactivation. [RCH]
Subscription on grace

RecurringBillingOnGraceNotification

View JSON and XML examples

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 reinstated

RecurringBillingReinstatedNotification

View JSON and XML examples

The subscription has been reactivated, and the customer will be expected to execute payment at the next billing date. [RCA]
Subscription deactivated

RecurringBillingCanceledNotification

View JSON and XML examples

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.

Tip

When you receive the RecurringBillingCanceledNotification, contact the customer by email and offer the individual the option to manually renew the subscription before the next billing date. If the customer does not want to renew the subscription, make sure to deactivate the customer's license so its validity is not extended.

[RCC]
Subscription reminder charge

SubscriptionReminderChargeNotification

View JSON and XML examples

A reminder that the subscription renewal is approaching for online payments. [RCR]
Subscription reminder payment expired

SubscriptionReminderPayOptExpNotification

View JSON and XML examples

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.

Note

Make 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

View JSON and XML examples

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

View JSON and XML examples

The profile data for a subscription was modified. For example, payment details. [CPU]
Subscription billing date extended

SubscriptionBillingDateExtendedNotification

View JSON and XML examples

The billing date for a customer's subscription has been changed or extended. [BDE]
New affiliate

NewAffiliateSignup

View JSON and XML examples

A new affiliate has signed up through the cleverbridge platform and has to be reviewed prior to being accepted. [NAF]
New partner

NewPartnerSignup

View JSON and XML examples

A new partner has signed up through the cleverbridge platform and has to be reviewed prior to being accepted. [NPA]
Error

ErrorNotification

Note

The data that 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 PaidOrderNotification is attached.

An error occurred during one of these scenarios:

  • while generating a license key,
  • while trying to send a notification,
  • while processing a payment,
  • while trying to integrate with Salesforce.

Note

See the Error Log in the Commerce Assistant in order to find out if further action is required on your part.

[ERR]
Subscription renewal type changed

SubscriptionRenewalTypeChangedNotification

View JSON and XML examples

A customer changed the subscription renewal type (automatic or manual). Subscription
Chargeback information request

ChargebackInformationRequestNotification

View JSON and XML examples

cleverbridge has decided to fight a chargeback request and needs you to provide us with additional information to help us fight it.

Note

This notification is delivered via email. Make 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 in the Commerce Assistant.

Note

There are two types of notifications that relate to chargebacks:

To receive both notifications, you must set up two separate notifications in the Commerce Assistant under Tools > Add Notifications. In the first notification, you should select Chargeback under Notification Events. In the second notification, you should select Chargeback information request under Notification Events. If you create one notification with both of these events, you will not receive the ChargebackInformationRequestNotification.

[CIR]
Awaiting release for purchase order

AwaitingReleaseForPurchaseOrderNotification

View JSON and XML examples

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 Commerce Assistant.

[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]