This is a list of events that are posted to the Callback URL defined in the Notification Settings. Some of these events are configurable on the “Events” section of the Notification Settings page (e.g. how many days after a declined payment should SubscriptionBridge reminder a customer to pay the outstanding balance?), other are not (e.g. you have no control on “when” a new customer buys a new subscription). The Notification Settings are defined at the store level within the SubscriptionBridge Merchant Center.
Events are posted in a universal XML standard formatting. The callback application or file you specify in your Callback URL must receive the event message. Next, it must parse the message to determine the event code. After the callback application knows event code of the message it has received it can use the GUID (unique subscription identifier) to perform a specific action. For example, if a callback application receives a message with event code “sb_n_3a” it will know that a trail was converted to full. The application can then parse the GUID from the message and use it to update the local database, perhaps enabling some new content or features that not available during the trial.
All event messages contain the same basic information:
A typical event message will appear as follows:
Sample
XML:
<?xml version="1.0" encoding="utf-8"?>
<SB_Callback>
<GUID>string</GUID>
<Event_Code>sb_n_1a</Event_Code>
</SB_Callback>
Scenario: new subscription included a trial period, which is about to expire. The trial may or may not have been free (could have been just a reduced rate), but in any case there is a change in the subscription amount or in the terms of the subscription.
Event Codes:
… where the number of days (“N” and “M”) is defined in the Notification Settings for the store.
Scenario: new subscription included a trial period, and the trial is stopped before it was scheduled to end. The trial may be stopped directly by the customer (e.g. via the SubscriptionBridge Customer Center) or by the merchant (e.g. customer calls in or sends an email asking for the subscription to be switched to full mode).
Event Codes:
Scenario: Regular subscription payment, charged successfully. This is not a payment receipt, since SubscriptionBridge is not the payment processor. A separate payment receipt might be sent directly by the payment gateway. This notification is instead a “Subscription Statement” which confirms that payment has been processed and provides other information on the subscription.
Event Codes:
sb_n_4a - Sent to Customer: subscription statement following successful payment
sb_n_4b - Sent to Customer: final subscription statement following last payment occurrence (limited time subscription)
sb_n_4c - Sent to Merchant: notification of successful payment
Scenario: Regular subscription payment that does not go through successfully. A separate “payment declined” message might be sent directly by the payment gateway. That message, however, does not tell the customer what to do next, unlike the message sent by SubscriptionBridge.
Event Codes:
Scenario: one or more subscription payments did not go through successfully. Therefore, there was an outstanding balance on the account, which the customer has now paid (e.g. through the SubscriptionBridge Customer Center). There is no notification for unsuccessful payment because the notification is in real time, on the payment page, since this is not an automatic payment.
Event Codes:
Scenario: one or more subscription payments did not go through successfully. Therefore, there is an outstanding balance on the account. The customer has not paid the balance and a certain number of days have passed (where “P” and “Q” - the number of days mentioned below - are defined in the
Notification Settings area of the Merchant Center).
Event Codes:
sb_n_7a - Sent to Customer: P days have passed since unsuccessful payment
sb_n_7b - Sent to Customer: Q days have passed since unsuccessful payment, final notice
sb_n_7c - Sent to Merchant: notification of the 7a
sb_n_7d - Sent to Merchant: notification of the 7b
sb_n_7e - Sent to Customer: R days have passed since unsuccessful payment, action taken
sb_n_7f - Sent to Merchant: notification of action taken in 7.e
Scenario: the customer upgraded (different Packages sharing the same Plan), downgraded, added Feature(s), removed Feature(s).
Event Codes:
sb_n_9a - Sent to Customer: confirmation of change of Package
sb_n_9b - Sent to Customer: confirmation of change of Features
sb_n_9c - Sent to Merchant: notification of change of Package
sb_n_9d - Sent to Merchant: notification of change of Features
Scenario: Merchant adds a feature on behalf of the customer, and there is a balance due for the current billing period (pro-rated amount), or makes a Custom Subscription Change that is associated with a balance due for the current billing period.
Event Codes:
-
Notifications sent via e-mail
A list of e-mail notifications sent by SubscriptionBridge when various events happen during the life of a subscription.
-
