| 1 |
<?php |
| 2 |
// @codingStandardsIgnoreFile |
| 3 |
/** |
| 4 |
* Menu page for the s2Member plugin (API Notifications page). |
| 5 |
* |
| 6 |
* Copyright: © 2009-2011 |
| 7 |
* {@link http://websharks-inc.com/ WebSharks, Inc.} |
| 8 |
* (coded in the USA) |
| 9 |
* |
| 10 |
* Released under the terms of the GNU General Public License. |
| 11 |
* You should have received a copy of the GNU General Public License, |
| 12 |
* along with this software. In the main directory, see: /licensing/ |
| 13 |
* If not, see: {@link http://www.gnu.org/licenses/}. |
| 14 |
* |
| 15 |
* @package s2Member\Menu_Pages |
| 16 |
* @since 3.0 |
| 17 |
*/ |
| 18 |
if(!defined('WPINC')) // MUST have WordPress. |
| 19 |
exit("Do not access this file directly."); |
| 20 |
|
| 21 |
if(!class_exists("c_ws_plugin__s2member_menu_page_api_ops")) |
| 22 |
{ |
| 23 |
/** |
| 24 |
* Menu page for the s2Member plugin (API Notifications page). |
| 25 |
* |
| 26 |
* @package s2Member\Menu_Pages |
| 27 |
* @since 110531 |
| 28 |
*/ |
| 29 |
class c_ws_plugin__s2member_menu_page_api_ops |
| 30 |
{ |
| 31 |
public function __construct() |
| 32 |
{ |
| 33 |
echo '<div class="wrap ws-menu-page">'."\n"; |
| 34 |
|
| 35 |
echo '<div class="wp-header-end"></div>'."\n"; |
| 36 |
|
| 37 |
echo '<div class="ws-menu-page-toolbox">'."\n"; |
| 38 |
c_ws_plugin__s2member_menu_pages_tb::display(); |
| 39 |
echo '</div>'."\n"; |
| 40 |
|
| 41 |
echo '<h2>API / Notifications</h2>'."\n"; |
| 42 |
|
| 43 |
echo '<table class="ws-menu-page-table">'."\n"; |
| 44 |
echo '<tbody class="ws-menu-page-table-tbody">'."\n"; |
| 45 |
echo '<tr class="ws-menu-page-table-tr">'."\n"; |
| 46 |
echo '<td class="ws-menu-page-table-l">'."\n"; |
| 47 |
|
| 48 |
do_action("ws_plugin__s2member_during_api_ops_page_before_left_sections_form", get_defined_vars()); |
| 49 |
|
| 50 |
echo '<form method="post" name="ws_plugin__s2member_options_form" id="ws-plugin--s2member-options-form" autocomplete="off">'."\n"; |
| 51 |
echo '<input type="hidden" name="ws_plugin__s2member_options_save" id="ws-plugin--s2member-options-save" value="'.esc_attr(wp_create_nonce("ws-plugin--s2member-options-save")).'" />'."\n"; |
| 52 |
echo '<input type="hidden" name="ws_plugin__s2member_configured" id="ws-plugin--s2member-configured" value="1" />'."\n"; |
| 53 |
|
| 54 |
do_action("ws_plugin__s2member_during_api_ops_page_before_left_sections", get_defined_vars()); |
| 55 |
|
| 56 |
if(apply_filters("ws_plugin__s2member_during_api_ops_page_during_left_sections_display_signup_notifications", TRUE, get_defined_vars())) |
| 57 |
{ |
| 58 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_before_signup_notifications", get_defined_vars()); |
| 59 |
|
| 60 |
echo '<div class="ws-menu-page-group" title="Signup Notifications">'."\n"; |
| 61 |
|
| 62 |
echo '<div class="ws-menu-page-section ws-plugin--s2member-signup-notifications-section">'."\n"; |
| 63 |
echo '<h3>Signup Notification URLs (optional)</h3>'."\n"; |
| 64 |
echo '<p>If you use affiliate software, or have back-office routines that need to be notified whenever a new Subscription is created, you\'ll want to read this section. This is marked `Signup`, because the URLs that you list below, will be notified each time a "new", "paying" Member signs up. Depending on your fee structure, this may include a payment that establishes their Subscription, or it may not. This Notification will only be triggered once for each Member. Signup Notifications are sent right after a "new", "paying" Member signs up successfully through your Payment Gateway, regardless of whether any money has actually been transacted. In other words, this Notification is triggered anytime a "new", "paying" Member signs up through your Payment Gateway, even if you provided them with something for free <em>(i.e., even if no money is being transacted)</em>.</p>'."\n"; |
| 65 |
echo '<p>This Notification will NOT be processed for Free Subscribers that register without going through your Payment Gateway at all (i.e., they simply register on-site; and there is no checkout whatsoever). This Notification will NOT be processed when an "existing" User/Member pays for a new Subscription <em>(see: Modification Notifications for that scenario)</em>.'.((is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site()) ? '' : ' And, this Notification will NOT be processed on Buy Now transactions for Independent Custom Capabilities <em>(see: Payment Notifications for that scenario)</em>.').'</p>'."\n"; |
| 66 |
echo '<p>Please note, this feature is not to be confused with the PayPal IPN service. PayPal IPN <em>(and other service integrations)</em> are already built into s2Member. They remain active at all times. These Signup Notifications are an added layer of functionality, and they are completely optional.</p>'."\n"; |
| 67 |
echo '<p><strong>See also:</strong> This KB article: <a href="http://www.s2member.com/kb/building-an-api-notification-handler/" target="_blank" rel="external">Building An API Notification Handler</a>.</p>'."\n"; |
| 68 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_during_signup_notifications", get_defined_vars()); |
| 69 |
|
| 70 |
echo '<table class="form-table">'."\n"; |
| 71 |
echo '<tbody>'."\n"; |
| 72 |
echo '<tr>'."\n"; |
| 73 |
|
| 74 |
echo '<th>'."\n"; |
| 75 |
echo '<label for="ws-plugin--s2member-signup-notification-urls">'."\n"; |
| 76 |
echo 'Signup Notification URLs:'."\n"; |
| 77 |
echo '</label>'."\n"; |
| 78 |
echo '</th>'."\n"; |
| 79 |
|
| 80 |
echo '</tr>'."\n"; |
| 81 |
echo '<tr>'."\n"; |
| 82 |
|
| 83 |
echo '<td>'."\n"; |
| 84 |
echo 'You can input multiple Notification URLs by inserting one per line.<br />'."\n"; |
| 85 |
echo '<textarea name="ws_plugin__s2member_signup_notification_urls" id="ws-plugin--s2member-signup-notification-urls" rows="3" wrap="off">'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["signup_notification_urls"]).'</textarea><br />'."\n"; |
| 86 |
echo 'Signup Notifications take place silently behind-the-scenes, using an HTTP connection.<br /><br />'."\n"; |
| 87 |
echo '<strong>You can also use these special Replacement Codes if you need them:</strong>'."\n"; |
| 88 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 89 |
echo '<li><code>%%subscr_id%%</code> = The Paid Subscription ID, which remains constant throughout any & all future payments. [ <a href="#" onclick="alert(\'There is one exception. If you are selling Lifetime or Fixed-Term (non-recurring) access, using Buy Now functionality; the %%subscr_id%% is actually set to the Transaction ID for the purchase. Payment Gateways do not provide a specific Subscription ID for Buy Now purchases. Since Lifetime & Fixed-Term Subscriptions are NOT recurring (i.e., there is only ONE payment), using the Transaction ID as the Subscription ID is a graceful way to deal with this minor conflict.\'); return false;">?</a> ]</li>'."\n"; |
| 90 |
echo '<li><code>%%subscr_baid%%</code> = Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that require a Billing Agreement. This is the Subscription\'s Billing Agreement ID, which remains constant throughout any & all future payments. [ <a href="#" onclick="alert(\'Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that require a Billing Agreement. In all other cases, the %%subscr_baid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% in most cases.\'); return false;">?</a> ]</li>'."\n"; |
| 91 |
echo '<li><code>%%subscr_cid%%</code> = Applicable only with Stripe integration. This is the Customer\'s ID in Stripe, which remains constant throughout any & all future payments. Each Stripe Customer has this Customer ID; and also a Subscription and/or Transaction ID [ <a href="#" onclick="alert(\'Applicable only when you integrate s2Member with Stripe. In all other cases, the %%subscr_cid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% when running anything other than Stripe.\\n\\nEach Stripe Customer has a Customer ID; and also a Subscription and/or Transaction ID. See %%subscr_id%% for further details.\'); return false;">?</a> ]</li>'."\n"; |
| 92 |
echo '<li><code>%%currency%%</code> = Three-character currency code (uppercase); e.g., <code>USD</code></li>'."\n"; |
| 93 |
echo '<li><code>%%currency_symbol%%</code> = Currency code symbol; e.g., <code>$</code></li>'."\n"; |
| 94 |
echo '<li><code>%%initial%%</code> = The Initial Fee charged during signup. If you offered a 100% Free Trial, this will be <code>0</code>. [ <a href="#" onclick="alert(\'This will always represent the amount of money the Customer spent, whenever they initially signed up, no matter what. Even if that amount is 0.\\n\\nIf a Customer signs up, under the terms of a 100% Free Trial Period, this will be 0. So be careful using %%initial%% when you offer a 100% Free Trial Period, because a $0.00 sale amount could cause havoc with affiliate programs.\\n\\nIf you\\\'re offering a 100% Free Trial Period, and you need to track sales through affiliate programs, you can either hard-code an amount; or use `Payment Notifications` instead.\'); return false;">?</a> ]</li>'."\n"; |
| 95 |
echo '<li><code>%%regular%%</code> = The Regular Amount of the Subscription. If you offer something 100% free, this will be <code>0</code>. [ <a href="#" onclick="alert(\'This is how much the Subscription costs after an Initial Period expires. If you did NOT offer an Initial Period at a different price, %%initial%% and %%regular%% will be equal to the same thing.\'); return false;">?</a> ]</li>'."\n"; |
| 96 |
echo '<li><code>%%recurring%%</code> = This is the amount that will be charged on a recurring basis, or <code>0</code> if non-recurring. [ <a href="#" onclick="alert(\'If Recurring Payments have not been required, this will be equal to 0. That being said, %%regular%% & %%recurring%% are usually the same value. This variable can be used in two different ways. You can use it to determine what the Regular Recurring Rate is, or to determine whether the Subscription will recur or not. If it is going to recur, %%recurring%% will be > 0.\'); return false;">?</a> ]</li>'."\n"; |
| 97 |
echo '<li><code>%%first_name%%</code> = The First Name of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 98 |
echo '<li><code>%%last_name%%</code> = The Last Name of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 99 |
echo '<li><code>%%full_name%%</code> = The Full Name (First & Last) of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 100 |
echo '<li><code>%%payer_email%%</code> = The Email Address of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 101 |
echo '<li><code>%%user_ip%%</code> = The Customer\'s IP Address, detected during checkout via <code>$_SERVER["REMOTE_ADDR"]</code>.</li>'."\n"; |
| 102 |
echo '<li><code>%%item_number%%</code> = The Item Number (colon separated <code><em>level:custom_capabilities:fixed term</em></code>) for the Membership Subscription.</li>'."\n"; |
| 103 |
echo '<li><code>%%item_name%%</code> = The Item Name (as provided by the <code>desc=""</code> attribute in your Shortcode, which briefly describes the Item Number).</li>'."\n"; |
| 104 |
echo '<li><code>%%initial_term%%</code> = This is the term length of the Initial Period. This will be a numeric value, followed by a space, then a single letter. [ <a href="#" onclick="alert(\'Here are some examples:\\n\\n%%initial_term%% = 1 D (this means 1 Day)\\n%%initial_term%% = 1 W (this means 1 Week)\\n%%initial_term%% = 1 M (this means 1 Month)\\n%%initial_term%% = 1 Y (this means 1 Year)\\n\\nThe Initial Period never recurs, so this only lasts for the term length specified, then it is over.\'); return false;">?</a> ]</li>'."\n"; |
| 105 |
echo '<li><code>%%regular_term%%</code> = This is the term length of the Regular Period. This will be a numeric value, followed by a space, then a single letter. [ <a href="#" onclick="alert(\'Here are some examples:\\n\\n%%regular_term%% = 1 D (this means 1 Day)\\n%%regular_term%% = 1 W (this means 1 Week)\\n%%regular_term%% = 1 M (this means 1 Month)\\n%%regular_term%% = 1 Y (this means 1 Year)\\n%%regular_term%% = 1 L (this means 1 Lifetime)\\n\\nThe Regular Term is usually recurring. So the Regular Term value represents the period (or duration) of each recurring period. If %%recurring%% = 0, then the Regular Term only applies once, because it is not recurring. So if it is not recurring, the value of %%regular_term%% simply represents how long their Membership privileges are going to last after the %%initial_term%% has expired, if there was an Initial Term. The value of this variable ( %%regular_term%% ) will never be empty, it will always be at least: 1 D, meaning 1 day. No exceptions.\'); return false;">?</a> ]</li>'."\n"; |
| 106 |
echo '</ul>'."\n"; |
| 107 |
|
| 108 |
if(c_ws_plugin__s2member_utils_conds::pro_is_installed()) |
| 109 |
{ |
| 110 |
echo '<strong>Coupon Replacement Codes (applicable only w/ s2Member Pro-Forms):</strong>'."\n"; |
| 111 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 112 |
echo '<li><code>%%full_coupon_code%%</code> = A full Coupon Code—if one is accepted by your configuration of s2Member. This may indicate an Affiliate Coupon Code, which will include your Affiliate Suffix Chars too (i.e., the full Coupon Code).</li>'."\n"; |
| 113 |
echo '<li><code>%%coupon_code%%</code> = A Coupon Code—if one is accepted by your configuration of s2Member. This will NOT include any Affiliate Suffix Chars. This indicates the actual Coupon Code accepted by your configuration of s2Member (excluding any Affiliate ID).</li>'."\n"; |
| 114 |
echo '<li><code>%%coupon_affiliate_id%%</code> = This is the end of an Affiliate Coupon Code <em>(i.e., the referring affiliate\'s ID)</em>. This is only applicable if an Affiliate Coupon Code is accepted by your configuration of s2Member.</li>'."\n"; |
| 115 |
echo '</ul>'."\n"; |
| 116 |
} |
| 117 |
|
| 118 |
echo '<strong>Custom Replacement Codes can also be inserted using these instructions:</strong>'."\n"; |
| 119 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 120 |
echo '<li><code>%%cv0%%</code> = The domain of your site, which is passed through the `custom` attribute in your Shortcode.</li>'."\n"; |
| 121 |
echo '<li><code>%%cv1%%</code> = If you need to track additional custom variables, you can pipe delimit them into the `custom` attribute; inside your Shortcode, like this: <code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|cv1|cv2|cv3"</code>. You can have an unlimited number of custom variables. Obviously, this is for advanced webmasters; but the functionality has been made available for those who need it.</li>'."\n"; |
| 122 |
echo '</ul>'."\n"; |
| 123 |
echo '<strong>This example uses cv1 to record a special marketing campaign:</strong><br />'."\n"; |
| 124 |
echo '<em>(The campaign (i.e., christmas-promo) could be referenced using <code>%%cv1%%</code>)</em><br />'."\n"; |
| 125 |
echo '<code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|christmas-promo"</code>'."\n"; |
| 126 |
|
| 127 |
echo '</td>'."\n"; |
| 128 |
|
| 129 |
echo '</tr>'."\n"; |
| 130 |
echo '</tbody>'."\n"; |
| 131 |
echo '</table>'."\n"; |
| 132 |
|
| 133 |
echo '<div class="ws-menu-page-hr"></div>'."\n"; |
| 134 |
|
| 135 |
echo '<table class="form-table" style="margin-top:0;">'."\n"; |
| 136 |
echo '<tbody>'."\n"; |
| 137 |
echo '<tr>'."\n"; |
| 138 |
|
| 139 |
echo '<th style="padding-top:0;">'."\n"; |
| 140 |
echo '<label for="ws-plugin--s2member-signup-notification-recipients">'."\n"; |
| 141 |
echo 'Send An Email Transaction Log Of This Event?'."\n"; |
| 142 |
echo '</label>'."\n"; |
| 143 |
echo '</th>'."\n"; |
| 144 |
|
| 145 |
echo '</tr>'."\n"; |
| 146 |
echo '<tr>'."\n"; |
| 147 |
|
| 148 |
echo '<td>'."\n"; |
| 149 |
echo '<input type="text" autocomplete="off" name="ws_plugin__s2member_signup_notification_recipients" id="ws-plugin--s2member-signup-notification-recipients" value="'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["signup_notification_recipients"]).'" /><br />'."\n"; |
| 150 |
echo 'This is a semicolon ( ; ) delimited list of Recipients. Here is an example:<br />'."\n"; |
| 151 |
echo '<code>"John" <john@example.com>; admin@example.com; "Webmaster" <webmaster@example.com></code>'."\n"; |
| 152 |
echo '</td>'."\n"; |
| 153 |
|
| 154 |
echo '</tr>'."\n"; |
| 155 |
echo '</tbody>'."\n"; |
| 156 |
echo '</table>'."\n"; |
| 157 |
echo '</div>'."\n"; |
| 158 |
|
| 159 |
echo '</div>'."\n"; |
| 160 |
} |
| 161 |
|
| 162 |
if(apply_filters("ws_plugin__s2member_during_api_ops_page_during_left_sections_display_registration_notifications", TRUE, get_defined_vars())) |
| 163 |
{ |
| 164 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_before_registration_notifications", get_defined_vars()); |
| 165 |
|
| 166 |
echo '<div class="ws-menu-page-group" title="Registration Notifications">'."\n"; |
| 167 |
|
| 168 |
echo '<div class="ws-menu-page-section ws-plugin--s2member-registration-notifications-section">'."\n"; |
| 169 |
echo '<h3>Registration Notification URLs (optional)</h3>'."\n"; |
| 170 |
echo '<p>If you use affiliate software, or have back-office routines that need to be notified whenever a "new" Member is created, you\'ll want to read this section. This is marked `Registration`, because the URLs that you list below, will be notified each time a "new" Member registers a Username. This is usually triggered right after a `Signup` Notification; at the point in which a "new" Member successfully completes the Registration form, and they are assigned a Username.</p>'."\n"; |
| 171 |
echo '<p>This Notification is ALSO triggered whenever you create a "new" User inside your WordPress Dashboard.</p>'."\n"; |
| 172 |
echo '<p>Please note, this feature is not to be confused with the PayPal IPN service. PayPal IPN <em>(and other service integrations)</em> are already built into s2Member. They remain active at all times. These Registration Notifications are an added layer of functionality, and they are completely optional.</p>'."\n"; |
| 173 |
echo '<p><strong>See also:</strong> This KB article: <a href="http://www.s2member.com/kb/building-an-api-notification-handler/" target="_blank" rel="external">Building An API Notification Handler</a>.</p>'."\n"; |
| 174 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_during_registration_notifications", get_defined_vars()); |
| 175 |
|
| 176 |
echo '<table class="form-table">'."\n"; |
| 177 |
echo '<tbody>'."\n"; |
| 178 |
echo '<tr>'."\n"; |
| 179 |
|
| 180 |
echo '<th>'."\n"; |
| 181 |
echo '<label for="ws-plugin--s2member-registration-notification-urls">'."\n"; |
| 182 |
echo 'Registration Notification URLs:'."\n"; |
| 183 |
echo '</label>'."\n"; |
| 184 |
echo '</th>'."\n"; |
| 185 |
|
| 186 |
echo '</tr>'."\n"; |
| 187 |
echo '<tr>'."\n"; |
| 188 |
|
| 189 |
echo '<td>'."\n"; |
| 190 |
echo 'You can input multiple Notification URLs by inserting one per line.<br />'."\n"; |
| 191 |
echo '<textarea name="ws_plugin__s2member_registration_notification_urls" id="ws-plugin--s2member-registration-notification-urls" rows="3" wrap="off">'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["registration_notification_urls"]).'</textarea><br />'."\n"; |
| 192 |
echo 'Registration Notifications take place silently behind-the-scenes, using an HTTP connection.<br /><br />'."\n"; |
| 193 |
echo '<strong>You can also use these special Replacement Codes if you need them:</strong>'."\n"; |
| 194 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 195 |
echo '<li><code>%%role%%</code> = The Role ID <code>(subscriber, s2member_level[0-9]+, administrator, editor, author, contributor)</code>.</li>'."\n"; |
| 196 |
echo '<li><code>%%level%%</code> = The Level number <code>(0, 1, 2, 3, 4)</code>. (<em>deprecated, no longer recommended; use <code>%%role%%</code></em>)</li>'."\n"; |
| 197 |
echo '<li><code>%%ccaps%%</code> = Custom Capabilities. Ex: <code>music,videos,free_gift</code> (<em>in comma-delimited format</em>).</li>'."\n"; |
| 198 |
echo '<li><code>%%auto_eot_time%%</code> = Auto-EOT Time (if applicable). Ex: <code>1299925670</code> (<em>unix timestamp</em>).</li>'."\n"; |
| 199 |
echo '<li><code>%%user_first_name%%</code> = The First Name of the Member who registered their Username.</li>'."\n"; |
| 200 |
echo '<li><code>%%user_last_name%%</code> = The Last Name of the Member who registered their Username.</li>'."\n"; |
| 201 |
echo '<li><code>%%user_full_name%%</code> = The Full Name (First & Last) of the Member who registered their Username.</li>'."\n"; |
| 202 |
echo '<li><code>%%user_email%%</code> = The Email Address of the Member who registered their Username.</li>'."\n"; |
| 203 |
echo '<li><code>%%user_login%%</code> = The Username the Member selected during registration.</li>'."\n"; |
| 204 |
echo '<li><code>%%user_pass%%</code> = The Password selected or generated during registration.</li>'."\n"; |
| 205 |
echo '<li><code>%%user_ip%%</code> = The User\'s IP Address, detected via <code>$_SERVER["REMOTE_ADDR"]</code>.</li>'."\n"; |
| 206 |
echo '<li><code>%%user_id%%</code> = A unique WordPress User ID generated during registration.</li>'."\n"; |
| 207 |
echo '</ul>'."\n"; |
| 208 |
|
| 209 |
echo '<strong>Custom Registration/Profile Fields are also supported in this Notification:</strong>'."\n"; |
| 210 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 211 |
echo '<li><code>%%date_of_birth%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>date_of_birth</code>.</li>'."\n"; |
| 212 |
echo '<li><code>%%street_address%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>street_address</code>.</li>'."\n"; |
| 213 |
echo '<li><code>%%country%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>country</code>.</li>'."\n"; |
| 214 |
echo '<li><em><code>%%etc, etc...%%</code> <strong>see:</strong> s2Member → General Options → Registration/Profile Fields</em>.</li>'."\n"; |
| 215 |
echo '</ul>'."\n"; |
| 216 |
|
| 217 |
echo '<strong>Custom Replacement Codes can also be inserted using these instructions:</strong>'."\n"; |
| 218 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 219 |
echo '<li><code>%%cv0%%</code> = The domain of your site, which is passed through the `custom` attribute in your Shortcode.</li>'."\n"; |
| 220 |
echo '<li><code>%%cv1%%</code> = If you need to track additional custom variables, you can pipe delimit them into the `custom` attribute; inside your Shortcode, like this: <code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|cv1|cv2|cv3"</code>. You can have an unlimited number of custom variables. Obviously, this is for advanced webmasters; but the functionality has been made available for those who need it.</li>'."\n"; |
| 221 |
echo '</ul>'."\n"; |
| 222 |
echo '<strong>This example uses cv1 to record a special marketing campaign:</strong><br />'."\n"; |
| 223 |
echo '<em>(The campaign (i.e., christmas-promo) could be referenced using <code>%%cv1%%</code>)</em><br />'."\n"; |
| 224 |
echo '<code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|christmas-promo"</code>'."\n"; |
| 225 |
|
| 226 |
echo '</td>'."\n"; |
| 227 |
|
| 228 |
echo '</tr>'."\n"; |
| 229 |
echo '</tbody>'."\n"; |
| 230 |
echo '</table>'."\n"; |
| 231 |
|
| 232 |
echo '<div class="ws-menu-page-hr"></div>'."\n"; |
| 233 |
|
| 234 |
echo '<table class="form-table" style="margin-top:0;">'."\n"; |
| 235 |
echo '<tbody>'."\n"; |
| 236 |
echo '<tr>'."\n"; |
| 237 |
|
| 238 |
echo '<th style="padding-top:0;">'."\n"; |
| 239 |
echo '<label for="ws-plugin--s2member-registration-notification-recipients">'."\n"; |
| 240 |
echo 'Send An Email Transaction Log Of This Event?'."\n"; |
| 241 |
echo '</label>'."\n"; |
| 242 |
echo '</th>'."\n"; |
| 243 |
|
| 244 |
echo '</tr>'."\n"; |
| 245 |
echo '<tr>'."\n"; |
| 246 |
|
| 247 |
echo '<td>'."\n"; |
| 248 |
echo '<input type="text" autocomplete="off" name="ws_plugin__s2member_registration_notification_recipients" id="ws-plugin--s2member-registration-notification-recipients" value="'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["registration_notification_recipients"]).'" /><br />'."\n"; |
| 249 |
echo 'This is a semicolon ( ; ) delimited list of Recipients. Here is an example:<br />'."\n"; |
| 250 |
echo '<code>"John" <john@example.com>; admin@example.com; "Webmaster" <webmaster@example.com></code>'."\n"; |
| 251 |
echo '</td>'."\n"; |
| 252 |
|
| 253 |
echo '</tr>'."\n"; |
| 254 |
echo '</tbody>'."\n"; |
| 255 |
echo '</table>'."\n"; |
| 256 |
echo '</div>'."\n"; |
| 257 |
|
| 258 |
echo '</div>'."\n"; |
| 259 |
|
| 260 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_after_registration_notifications", get_defined_vars()); |
| 261 |
} |
| 262 |
|
| 263 |
if(apply_filters("ws_plugin__s2member_during_api_ops_page_during_left_sections_display_payment_notifications", TRUE, get_defined_vars())) |
| 264 |
{ |
| 265 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_before_payment_notifications", get_defined_vars()); |
| 266 |
|
| 267 |
echo '<div class="ws-menu-page-group" title="Payment Notifications">'."\n"; |
| 268 |
|
| 269 |
echo '<div class="ws-menu-page-section ws-plugin--s2member-payment-notifications-section">'."\n"; |
| 270 |
echo '<h3>Payment Notification URLs (optional)</h3>'."\n"; |
| 271 |
echo '<p>If you use affiliate software, or have back-office routines that need to be notified whenever payment transactions <em>(including Recurring Payments)</em> take place, you\'ll want to read this section. This is marked `Payment`, because the URLs that you list below, will be notified each time an actual payment occurs. Depending on your fee structure, this may include a first Initial Payment that establishes a Subscription. But more importantly, this will be triggered on all future payments that are received for the lifetime of the Subscription.</p>'."\n"; |
| 272 |
echo '<p>So, unlike the `Signup` Notification, `Payment` Notifications take place whenever actual payments are received, instead of just once after signup is completed. If a payment is required during signup <em>(i.e., no Free Trial is being offered)</em>, a Signup Notification will be triggered, and a Payment Notification will ALSO be triggered. In other words, a Payment Notification occurs anytime funds are received, no matter what.</p>'."\n"; |
| 273 |
echo (!is_multisite() || !c_ws_plugin__s2member_utils_conds::is_multisite_farm() || is_main_site()) ? '<p>Payment Notifications are also triggered whenever a Buy Now purchase for Independent Custom Capabilities takes place.</p>'."\n" : ''; |
| 274 |
echo '<p>Please note, this feature is not to be confused with the PayPal IPN service. PayPal IPN <em>(and other service integrations)</em> are already built into s2Member. They remain active at all times. These Payment Notifications are an added layer of functionality, and they are completely optional.</p>'."\n"; |
| 275 |
echo '<p><strong>See also:</strong> This KB article: <a href="http://www.s2member.com/kb/building-an-api-notification-handler/" target="_blank" rel="external">Building An API Notification Handler</a>.</p>'."\n"; |
| 276 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_during_payment_notifications", get_defined_vars()); |
| 277 |
|
| 278 |
echo '<table class="form-table">'."\n"; |
| 279 |
echo '<tbody>'."\n"; |
| 280 |
echo '<tr>'."\n"; |
| 281 |
|
| 282 |
echo '<th>'."\n"; |
| 283 |
echo '<label for="ws-plugin--s2member-payment-notification-urls">'."\n"; |
| 284 |
echo 'Payment Notification URLs:'."\n"; |
| 285 |
echo '</label>'."\n"; |
| 286 |
echo '</th>'."\n"; |
| 287 |
|
| 288 |
echo '</tr>'."\n"; |
| 289 |
echo '<tr>'."\n"; |
| 290 |
|
| 291 |
echo '<td>'."\n"; |
| 292 |
echo 'You can input multiple Notification URLs by inserting one per line.<br />'."\n"; |
| 293 |
echo '<textarea name="ws_plugin__s2member_payment_notification_urls" id="ws-plugin--s2member-payment-notification-urls" rows="3" wrap="off">'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["payment_notification_urls"]).'</textarea><br />'."\n"; |
| 294 |
echo 'Payment Notifications take place silently behind-the-scenes, using an HTTP connection.<br /><br />'."\n"; |
| 295 |
echo '<strong>You can also use these special Replacement Codes if you need them:</strong>'."\n"; |
| 296 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 297 |
echo '<li><code>%%subscr_id%%</code> = The Paid Subscription ID, which remains constant throughout any & all future payments. [ <a href="#" onclick="alert(\'There are some exceptions. If you are selling Lifetime or Fixed-Term (non-recurring) access, and/or Independent Custom Capabilities, using Buy Now functionality; the %%subscr_id%% is actually set to the Transaction ID for the payment.\\n\\nPayment Gateways do not provide a specific Subscription ID for Buy Now purchases. Since Lifetime & Fixed-Term Subscriptions are NOT recurring (i.e., there is only ONE payment), which goes for Independent Custom Capability purchases too; using the Transaction ID as the Subscription ID is a graceful way to deal with this minor conflict.\'); return false;">?</a> ]</li>'."\n"; |
| 298 |
echo '<li><code>%%subscr_baid%%</code> = Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that require a Billing Agreement. This is the Subscription\'s Billing Agreement ID, which remains constant throughout any & all future payments. [ <a href="#" onclick="alert(\'Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that require a Billing Agreement. In all other cases, the %%subscr_baid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% in most cases.\'); return false;">?</a> ]</li>'."\n"; |
| 299 |
echo '<li><code>%%subscr_cid%%</code> = Applicable only with Stripe integration. This is the Customer\'s ID in Stripe, which remains constant throughout any & all future payments. Each Stripe Customer has this Customer ID; and also a Subscription and/or Transaction ID [ <a href="#" onclick="alert(\'Applicable only when you integrate s2Member with Stripe. In all other cases, the %%subscr_cid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% when running anything other than Stripe.\\n\\nEach Stripe Customer has a Customer ID; and also a Subscription and/or Transaction ID. See %%subscr_id%% for further details.\'); return false;">?</a> ]</li>'."\n"; |
| 300 |
echo '<li><code>%%txn_id%%</code> = The Payment Transaction ID, which is always unique for each payment received.</li>'."\n"; |
| 301 |
echo '<li><code>%%currency%%</code> = Three-character currency code (uppercase); e.g., <code>USD</code></li>'."\n"; |
| 302 |
echo '<li><code>%%currency_symbol%%</code> = Currency code symbol; e.g., <code>$</code></li>'."\n"; |
| 303 |
echo '<li><code>%%amount%%</code> = The Amount of the payment. Most affiliate programs calculate commissions from this.</li>'."\n"; |
| 304 |
echo '<li><code>%%first_name%%</code> = The First Name of the Customer who purchased the Membership Subscription'.((is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site()) ? '' : ' or Capabilities.').'</li>'."\n"; |
| 305 |
echo '<li><code>%%last_name%%</code> = The Last Name of the Customer who purchased the Membership Subscription'.((is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site()) ? '' : ' or Capabilities.').'</li>'."\n"; |
| 306 |
echo '<li><code>%%full_name%%</code> = The Full Name (First & Last) of the Customer who purchased the Membership Subscription'.((is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site()) ? '' : ' or Capabilities.').'</li>'."\n"; |
| 307 |
echo '<li><code>%%payer_email%%</code> = The Email Address of the Customer who purchased the Membership Subscription'.((is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site()) ? '' : ' or Capabilities.').'</li>'."\n"; |
| 308 |
echo '<li><code>%%item_number%%</code> = The Item Number (colon separated <code><em>level:custom_capabilities:fixed term</em></code>) that the payment is for.'.((is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site()) ? '' : ' [ <a href="#" onclick="alert(\'If the Payment Notification is for Independent Custom Capabilities, the `level` portion of this string will be an asterisk ( `*` ), since the Membership Level is irrelevant, and remains `as it was` in that scenario. In all other cases, the `level` portion will be a numeric value.\'); return false;">?</a> ]').'</li>'."\n"; |
| 309 |
echo '<li><code>%%item_name%%</code> = The Item Name (as provided by the <code>desc=""</code> attribute in your Shortcode, which briefly describes the Item Number).</li>'."\n"; |
| 310 |
echo '<li><code>%%user_first_name%%</code> = The First Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 311 |
echo '<li><code>%%user_last_name%%</code> = The Last Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 312 |
echo '<li><code>%%user_full_name%%</code> = The Full Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 313 |
echo '<li><code>%%user_email%%</code> = The Email Address associated with their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 314 |
echo '<li><code>%%user_login%%</code> = The Username associated with their account. The Customer created this during registration.</li>'."\n"; |
| 315 |
echo '<li><code>%%user_ip%%</code> = The Customer\'s original IP Address, during checkout/registration via <code>$_SERVER["REMOTE_ADDR"]</code>.</li>'."\n"; |
| 316 |
echo '<li><code>%%user_id%%</code> = A unique WordPress User ID that references this account in the WordPress database.</li>'."\n"; |
| 317 |
echo '</ul>'."\n"; |
| 318 |
|
| 319 |
if(c_ws_plugin__s2member_utils_conds::pro_is_installed()) |
| 320 |
{ |
| 321 |
echo '<strong>Coupon Replacement Codes (applicable only w/ s2Member Pro-Forms):</strong><br />'."\n"; |
| 322 |
echo '<em>These are ONLY included with payments that occur during checkout. They will NOT be provided with any future recurring payments.</em>'."\n"; |
| 323 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 324 |
echo '<li><code>%%full_coupon_code%%</code> = A full Coupon Code—if one is accepted by your configuration of s2Member. This may indicate an Affiliate Coupon Code, which will include your Affiliate Suffix Chars too (i.e., the full Coupon Code).</li>'."\n"; |
| 325 |
echo '<li><code>%%coupon_code%%</code> = A Coupon Code—if one is accepted by your configuration of s2Member. This will NOT include any Affiliate Suffix Chars. This indicates the actual Coupon Code accepted by your configuration of s2Member (excluding any Affiliate ID).</li>'."\n"; |
| 326 |
echo '<li><code>%%coupon_affiliate_id%%</code> = This is the end of an Affiliate Coupon Code <em>(i.e., the referring affiliate\'s ID)</em>. This is only applicable if an Affiliate Coupon Code is accepted by your configuration of s2Member.</li>'."\n"; |
| 327 |
echo '</ul>'."\n"; |
| 328 |
} |
| 329 |
|
| 330 |
echo '<strong>Custom Registration/Profile Fields are also supported in this Notification:</strong>'."\n"; |
| 331 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 332 |
echo '<li><code>%%date_of_birth%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>date_of_birth</code>.</li>'."\n"; |
| 333 |
echo '<li><code>%%street_address%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>street_address</code>.</li>'."\n"; |
| 334 |
echo '<li><code>%%country%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>country</code>.</li>'."\n"; |
| 335 |
echo '<li><em><code>%%etc, etc...%%</code> <strong>see:</strong> s2Member → General Options → Registration/Profile Fields</em>.</li>'."\n"; |
| 336 |
echo '</ul>'."\n"; |
| 337 |
|
| 338 |
echo '<strong>Custom Replacement Codes can also be inserted using these instructions:</strong>'."\n"; |
| 339 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 340 |
echo '<li><code>%%cv0%%</code> = The domain of your site, which is passed through the `custom` attribute in your Shortcode.</li>'."\n"; |
| 341 |
echo '<li><code>%%cv1%%</code> = If you need to track additional custom variables, you can pipe delimit them into the `custom` attribute; inside your Shortcode, like this: <code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|cv1|cv2|cv3"</code>. You can have an unlimited number of custom variables. Obviously, this is for advanced webmasters; but the functionality has been made available for those who need it.</li>'."\n"; |
| 342 |
echo '</ul>'."\n"; |
| 343 |
echo '<strong>This example uses cv1 to record a special marketing campaign:</strong><br />'."\n"; |
| 344 |
echo '<em>(The campaign (i.e., christmas-promo) could be referenced using <code>%%cv1%%</code>)</em><br />'."\n"; |
| 345 |
echo '<code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|christmas-promo"</code>'."\n"; |
| 346 |
|
| 347 |
echo '</td>'."\n"; |
| 348 |
|
| 349 |
echo '</tr>'."\n"; |
| 350 |
echo '</tbody>'."\n"; |
| 351 |
echo '</table>'."\n"; |
| 352 |
|
| 353 |
echo '<div class="ws-menu-page-hr"></div>'."\n"; |
| 354 |
|
| 355 |
echo '<table class="form-table" style="margin-top:0;">'."\n"; |
| 356 |
echo '<tbody>'."\n"; |
| 357 |
echo '<tr>'."\n"; |
| 358 |
|
| 359 |
echo '<th style="padding-top:0;">'."\n"; |
| 360 |
echo '<label for="ws-plugin--s2member-payment-notification-recipients">'."\n"; |
| 361 |
echo 'Send An Email Transaction Log Of This Event?'."\n"; |
| 362 |
echo '</label>'."\n"; |
| 363 |
echo '</th>'."\n"; |
| 364 |
|
| 365 |
echo '</tr>'."\n"; |
| 366 |
echo '<tr>'."\n"; |
| 367 |
|
| 368 |
echo '<td>'."\n"; |
| 369 |
echo '<input type="text" autocomplete="off" name="ws_plugin__s2member_payment_notification_recipients" id="ws-plugin--s2member-payment-notification-recipients" value="'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["payment_notification_recipients"]).'" /><br />'."\n"; |
| 370 |
echo 'This is a semicolon ( ; ) delimited list of Recipients. Here is an example:<br />'."\n"; |
| 371 |
echo '<code>"John" <john@example.com>; admin@example.com; "Webmaster" <webmaster@example.com></code>'."\n"; |
| 372 |
echo '</td>'."\n"; |
| 373 |
|
| 374 |
echo '</tr>'."\n"; |
| 375 |
echo '</tbody>'."\n"; |
| 376 |
echo '</table>'."\n"; |
| 377 |
echo '</div>'."\n"; |
| 378 |
|
| 379 |
echo '</div>'."\n"; |
| 380 |
|
| 381 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_after_payment_notifications", get_defined_vars()); |
| 382 |
} |
| 383 |
|
| 384 |
if(apply_filters("ws_plugin__s2member_during_api_ops_page_during_left_sections_display_modification_notifications", TRUE, get_defined_vars())) |
| 385 |
{ |
| 386 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_before_modification_notifications", get_defined_vars()); |
| 387 |
|
| 388 |
echo '<div class="ws-menu-page-group" title="Modification Notifications">'."\n"; |
| 389 |
|
| 390 |
echo '<div class="ws-menu-page-section ws-plugin--s2member-modification-notifications-section">'."\n"; |
| 391 |
echo '<h3>Modification Notification URLs (optional)</h3>'."\n"; |
| 392 |
echo '<p>If you use affiliate software, or have back-office routines that need to be notified each time a new Subscription is created by an "existing" User/Member, or an "existing" Member modifies their paid Subscription terms, you\'ll want to read this section. This is marked `Modification`, because the URLs that you list below, will be notified each time an "existing" User/Member <em>(even if they are/were a Free Subscriber)</em> signs up for a paid Subscription <em>(i.e., a Modification takes place against an existing account within WordPress)</em>, or an "existing" Member modifies their paid Subscription terms <em>(again, a Modification takes places against an existing account within WordPress)</em>. Depending on your fee structure, this may include a payment that establishes their Subscription, or it may not.</p>'."\n"; |
| 393 |
echo '<p>Modification Notifications are sent right after a Member signs up and/or modifies billing terms successfully through your Payment Gateway, regardless of whether any money has actually been transacted. In other words, this Notification is triggered, even if you provided them with something for free <em>(i.e., even if no money is being transacted)</em>.</p>'."\n"; |
| 394 |
echo '<p>This Notification will NOT be processed for "new" Users/Members <em>(see: Signup Notifications for that scenario)</em>.'.((is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site()) ? '' : ' And, this Notification will NOT be processed for Independent Custom Capability purchases <em>(see: Payment Notifications for that scenario)</em>.').'</p>'."\n"; |
| 395 |
echo '<p>Please note, this feature is not to be confused with the PayPal IPN service. PayPal IPN <em>(and other service integrations)</em> are already built into s2Member. They remain active at all times. These Modification Notifications are an added layer of functionality, and they are completely optional.</p>'."\n"; |
| 396 |
echo '<p><strong>See also:</strong> This KB article: <a href="http://www.s2member.com/kb/building-an-api-notification-handler/" target="_blank" rel="external">Building An API Notification Handler</a>.</p>'."\n"; |
| 397 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_during_modification_notifications", get_defined_vars()); |
| 398 |
|
| 399 |
echo '<table class="form-table">'."\n"; |
| 400 |
echo '<tbody>'."\n"; |
| 401 |
echo '<tr>'."\n"; |
| 402 |
|
| 403 |
echo '<th>'."\n"; |
| 404 |
echo '<label for="ws-plugin--s2member-modification-notification-urls">'."\n"; |
| 405 |
echo 'Modification Notification URLs:'."\n"; |
| 406 |
echo '</label>'."\n"; |
| 407 |
echo '</th>'."\n"; |
| 408 |
|
| 409 |
echo '</tr>'."\n"; |
| 410 |
echo '<tr>'."\n"; |
| 411 |
|
| 412 |
echo '<td>'."\n"; |
| 413 |
echo 'You can input multiple Notification URLs by inserting one per line.<br />'."\n"; |
| 414 |
echo '<textarea name="ws_plugin__s2member_modification_notification_urls" id="ws-plugin--s2member-modification-notification-urls" rows="3" wrap="off">'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["modification_notification_urls"]).'</textarea><br />'."\n"; |
| 415 |
echo 'Modification Notifications take place silently behind-the-scenes, using an HTTP connection.<br /><br />'."\n"; |
| 416 |
echo '<strong>You can also use these special Replacement Codes if you need them:</strong>'."\n"; |
| 417 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 418 |
echo '<li><code>%%subscr_id%%</code> = The Paid Subscription ID, which remains constant throughout any & all future payments. [ <a href="#" onclick="alert(\'There is one exception. If you are selling Lifetime or Fixed-Term (non-recurring) access, using Buy Now functionality; the %%subscr_id%% is actually set to the Transaction ID for the purchase. Payment Gateways do not provide a specific Subscription ID for Buy Now purchases. Since Lifetime & Fixed-Term Subscriptions are NOT recurring (i.e., there is only ONE payment), using the Transaction ID as the Subscription ID is a graceful way to deal with this minor conflict.\'); return false;">?</a> ]</li>'."\n"; |
| 419 |
echo '<li><code>%%subscr_baid%%</code> = Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that require a Billing Agreement. This is the Subscription\'s Billing Agreement ID, which remains constant throughout any & all future payments. [ <a href="#" onclick="alert(\'Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that require a Billing Agreement. In all other cases, the %%subscr_baid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% in most cases.\'); return false;">?</a> ]</li>'."\n"; |
| 420 |
echo '<li><code>%%subscr_cid%%</code> = Applicable only with Stripe integration. This is the Customer\'s ID in Stripe, which remains constant throughout any & all future payments. Each Stripe Customer has this Customer ID; and also a Subscription and/or Transaction ID [ <a href="#" onclick="alert(\'Applicable only when you integrate s2Member with Stripe. In all other cases, the %%subscr_cid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% when running anything other than Stripe.\\n\\nEach Stripe Customer has a Customer ID; and also a Subscription and/or Transaction ID. See %%subscr_id%% for further details.\'); return false;">?</a> ]</li>'."\n"; |
| 421 |
echo '<li><code>%%currency%%</code> = Three-character currency code (uppercase); e.g., <code>USD</code></li>'."\n"; |
| 422 |
echo '<li><code>%%currency_symbol%%</code> = Currency code symbol; e.g., <code>$</code></li>'."\n"; |
| 423 |
echo '<li><code>%%initial%%</code> = The Initial Fee. If you offered a 100% Free Trial, this will be <code>0</code>. [ <a href="#" onclick="alert(\'This will always represent the amount of money the Customer spent when they completed checkout, no matter what. Even if that amount is 0.\\n\\nIf a Customer upgrades/downgrades under the terms of a 100% Free Trial Period, this will be 0. So, please be careful using %%initial%% when you offer a 100% Free Trial Period, because a $0.00 sale amount could cause havoc with affiliate programs.\\n\\nIf you\\\'re offering a 100% Free Trial Period, and you need to track sales through affiliate programs, you can either hard-code an amount; or use `Payment Notifications` instead.\'); return false;">?</a> ]</li>'."\n"; |
| 424 |
echo '<li><code>%%regular%%</code> = The Regular Amount of the Subscription. If you offer something 100% free, this will be <code>0</code>. [ <a href="#" onclick="alert(\'This is how much the Subscription costs after an Initial Period expires. If you did NOT offer an Initial Period at a different price, %%initial%% and %%regular%% will be equal to the same thing.\'); return false;">?</a> ]</li>'."\n"; |
| 425 |
echo '<li><code>%%recurring%%</code> = This is the amount that will be charged on a recurring basis, or <code>0</code> if non-recurring. [ <a href="#" onclick="alert(\'If Recurring Payments have not been required, this will be equal to 0. That being said, %%regular%% & %%recurring%% are usually the same value. This variable can be used in two different ways. You can use it to determine what the Regular Recurring Rate is, or to determine whether the Subscription will recur or not. If it is going to recur, %%recurring%% will be > 0.\'); return false;">?</a> ]</li>'."\n"; |
| 426 |
echo '<li><code>%%first_name%%</code> = The First Name of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 427 |
echo '<li><code>%%last_name%%</code> = The Last Name of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 428 |
echo '<li><code>%%full_name%%</code> = The Full Name (First & Last) of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 429 |
echo '<li><code>%%payer_email%%</code> = The Email Address of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 430 |
echo '<li><code>%%item_number%%</code> = The Item Number (colon separated <code><em>level:custom_capabilities:fixed term</em></code>) for the Membership Subscription.</li>'."\n"; |
| 431 |
echo '<li><code>%%item_name%%</code> = The Item Name (as provided by the <code>desc=""</code> attribute in your Shortcode, which briefly describes the Item Number).</li>'."\n"; |
| 432 |
echo '<li><code>%%initial_term%%</code> = This is the term length of the Initial Period. This will be a numeric value, followed by a space, then a single letter. [ <a href="#" onclick="alert(\'Here are some examples:\\n\\n%%initial_term%% = 1 D (this means 1 Day)\\n%%initial_term%% = 1 W (this means 1 Week)\\n%%initial_term%% = 1 M (this means 1 Month)\\n%%initial_term%% = 1 Y (this means 1 Year)\\n\\nThe Initial Period never recurs, so this only lasts for the term length specified, then it is over.\'); return false;">?</a> ]</li>'."\n"; |
| 433 |
echo '<li><code>%%regular_term%%</code> = This is the term length of the Regular Period. This will be a numeric value, followed by a space, then a single letter. [ <a href="#" onclick="alert(\'Here are some examples:\\n\\n%%regular_term%% = 1 D (this means 1 Day)\\n%%regular_term%% = 1 W (this means 1 Week)\\n%%regular_term%% = 1 M (this means 1 Month)\\n%%regular_term%% = 1 Y (this means 1 Year)\\n%%regular_term%% = 1 L (this means 1 Lifetime)\\n\\nThe Regular Term is usually recurring. So the Regular Term value represents the period (or duration) of each recurring period. If %%recurring%% = 0, then the Regular Term only applies once, because it is not recurring. So if it is not recurring, the value of %%regular_term%% simply represents how long their Membership privileges are going to last after the %%initial_term%% has expired, if there was an Initial Term. The value of this variable ( %%regular_term%% ) will never be empty, it will always be at least: 1 D, meaning 1 day. No exceptions.\'); return false;">?</a> ]</li>'."\n"; |
| 434 |
echo '<li><code>%%user_first_name%%</code> = The First Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 435 |
echo '<li><code>%%user_last_name%%</code> = The Last Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 436 |
echo '<li><code>%%user_full_name%%</code> = The Full Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 437 |
echo '<li><code>%%user_email%%</code> = The Email Address associated with their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 438 |
echo '<li><code>%%user_login%%</code> = The Username associated with their account. The Customer created this during registration.</li>'."\n"; |
| 439 |
echo '<li><code>%%user_ip%%</code> = The Customer\'s original IP Address, during checkout/registration via <code>$_SERVER["REMOTE_ADDR"]</code>.</li>'."\n"; |
| 440 |
echo '<li><code>%%user_id%%</code> = A unique WordPress User ID that references this account in the WordPress database.</li>'."\n"; |
| 441 |
echo '</ul>'."\n"; |
| 442 |
|
| 443 |
if(c_ws_plugin__s2member_utils_conds::pro_is_installed()) |
| 444 |
{ |
| 445 |
echo '<strong>Coupon Replacement Codes (applicable only w/ s2Member Pro-Forms):</strong>'."\n"; |
| 446 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 447 |
echo '<li><code>%%full_coupon_code%%</code> = A full Coupon Code—if one is accepted by your configuration of s2Member. This may indicate an Affiliate Coupon Code, which will include your Affiliate Suffix Chars too (i.e., the full Coupon Code).</li>'."\n"; |
| 448 |
echo '<li><code>%%coupon_code%%</code> = A Coupon Code—if one is accepted by your configuration of s2Member. This will NOT include any Affiliate Suffix Chars. This indicates the actual Coupon Code accepted by your configuration of s2Member (excluding any Affiliate ID).</li>'."\n"; |
| 449 |
echo '<li><code>%%coupon_affiliate_id%%</code> = This is the end of an Affiliate Coupon Code <em>(i.e., the referring affiliate\'s ID)</em>. This is only applicable if an Affiliate Coupon Code is accepted by your configuration of s2Member.</li>'."\n"; |
| 450 |
echo '</ul>'."\n"; |
| 451 |
} |
| 452 |
|
| 453 |
echo '<strong>Custom Registration/Profile Fields are also supported in this Notification:</strong>'."\n"; |
| 454 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 455 |
echo '<li><code>%%date_of_birth%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>date_of_birth</code>.</li>'."\n"; |
| 456 |
echo '<li><code>%%street_address%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>street_address</code>.</li>'."\n"; |
| 457 |
echo '<li><code>%%country%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>country</code>.</li>'."\n"; |
| 458 |
echo '<li><em><code>%%etc, etc...%%</code> <strong>see:</strong> s2Member → General Options → Registration/Profile Fields</em>.</li>'."\n"; |
| 459 |
echo '</ul>'."\n"; |
| 460 |
|
| 461 |
echo '<strong>Custom Replacement Codes can also be inserted using these instructions:</strong>'."\n"; |
| 462 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 463 |
echo '<li><code>%%cv0%%</code> = The domain of your site, which is passed through the `custom` attribute in your Shortcode.</li>'."\n"; |
| 464 |
echo '<li><code>%%cv1%%</code> = If you need to track additional custom variables, you can pipe delimit them into the `custom` attribute; inside your Shortcode, like this: <code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|cv1|cv2|cv3"</code>. You can have an unlimited number of custom variables. Obviously, this is for advanced webmasters; but the functionality has been made available for those who need it.</li>'."\n"; |
| 465 |
echo '</ul>'."\n"; |
| 466 |
echo '<strong>This example uses cv1 to record a special marketing campaign:</strong><br />'."\n"; |
| 467 |
echo '<em>(The campaign (i.e., christmas-promo) could be referenced using <code>%%cv1%%</code>)</em><br />'."\n"; |
| 468 |
echo '<code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|christmas-promo"</code>'."\n"; |
| 469 |
|
| 470 |
echo '</td>'."\n"; |
| 471 |
|
| 472 |
echo '</tr>'."\n"; |
| 473 |
echo '</tbody>'."\n"; |
| 474 |
echo '</table>'."\n"; |
| 475 |
|
| 476 |
echo '<div class="ws-menu-page-hr"></div>'."\n"; |
| 477 |
|
| 478 |
echo '<table class="form-table" style="margin-top:0;">'."\n"; |
| 479 |
echo '<tbody>'."\n"; |
| 480 |
echo '<tr>'."\n"; |
| 481 |
|
| 482 |
echo '<th style="padding-top:0;">'."\n"; |
| 483 |
echo '<label for="ws-plugin--s2member-modification-notification-recipients">'."\n"; |
| 484 |
echo 'Send An Email Transaction Log Of This Event?'."\n"; |
| 485 |
echo '</label>'."\n"; |
| 486 |
echo '</th>'."\n"; |
| 487 |
|
| 488 |
echo '</tr>'."\n"; |
| 489 |
echo '<tr>'."\n"; |
| 490 |
|
| 491 |
echo '<td>'."\n"; |
| 492 |
echo '<input type="text" autocomplete="off" name="ws_plugin__s2member_modification_notification_recipients" id="ws-plugin--s2member-modification-notification-recipients" value="'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["modification_notification_recipients"]).'" /><br />'."\n"; |
| 493 |
echo 'This is a semicolon ( ; ) delimited list of Recipients. Here is an example:<br />'."\n"; |
| 494 |
echo '<code>"John" <john@example.com>; admin@example.com; "Webmaster" <webmaster@example.com></code>'."\n"; |
| 495 |
echo '</td>'."\n"; |
| 496 |
|
| 497 |
echo '</tr>'."\n"; |
| 498 |
echo '</tbody>'."\n"; |
| 499 |
echo '</table>'."\n"; |
| 500 |
echo '</div>'."\n"; |
| 501 |
|
| 502 |
echo '</div>'."\n"; |
| 503 |
} |
| 504 |
|
| 505 |
if(apply_filters("ws_plugin__s2member_during_api_ops_page_during_left_sections_display_cancellation_notifications", TRUE, get_defined_vars())) |
| 506 |
{ |
| 507 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_before_cancellation_notifications", get_defined_vars()); |
| 508 |
|
| 509 |
echo '<div class="ws-menu-page-group" title="Cancellation Notifications">'."\n"; |
| 510 |
|
| 511 |
echo '<div class="ws-menu-page-section ws-plugin--s2member-cancellation-notifications-section">'."\n"; |
| 512 |
echo '<h3>Cancellation Notification URLs (optional)</h3>'."\n"; |
| 513 |
echo '<p>If you use affiliate software, or have back-office routines that need to be notified whenever Subscriptions are cancelled through your Payment Gateway, you\'ll want to read this section. This is marked `Cancellation`, because the URLs that you list below, will be notified each time a Subscription is cancelled. A Cancellation is triggered when you cancel a Customer\'s Subscription through your Payment Gateway, or when a Customer cancels their own Subscription.</p>'."\n"; |
| 514 |
echo '<p>Please note, this feature is not to be confused with the PayPal IPN service. PayPal IPN <em>(and other service integrations)</em> are already built into s2Member. They remain active at all times. These Cancellation Notifications are an added layer of functionality, and they are completely optional.</p>'."\n"; |
| 515 |
echo '<p><em><strong>Understanding Cancellations:</strong> It\'s important to realize that a Cancellation is not an EOT (End Of Term). All that happens during a Cancellation event, is that billing is stopped, and it\'s understood that the Customer is going to lose access, at some point in the future. This does NOT mean, that access will be revoked immediately. A separate EOT event will automatically handle a (demotion or deletion) later, at the appropriate time; which could be several days, or even a year after the Cancellation took place.</em></p>'."\n"; |
| 516 |
echo '<p><em><strong>Some Hairy Details:</strong> There might be times whenever you notice that a Member\'s Subscription has been cancelled through your Payment Gateway... but, s2Member continues allowing the User access to your site as a paid Member. Please don\'t be confused by this... in 99.9% of these cases, the reason for this is legitimate. s2Member will only process the membership EOT when an EOT (End Of Term) is reached, a refund occurs, a chargeback occurs, or when a cancellation later results in a delayed Auto-EOT by s2Member.</em></p>'."\n"; |
| 517 |
echo '<p><em>s2Member will not process an EOT (End Of Term) until the User has completely used up the time they paid for. In other words, if a User signs up for a monthly Subscription on Jan 1st, and then cancels their Subscription on Jan 15th; technically, they should still be allowed to access the site for another 15 days, and then on Feb 1st, the time they paid for has completely elapsed. At that time, s2Member will process their membership EOT by either assigning the role selected under Demote To Role or applying the configured Delete behavior. s2Member also calculates one extra day (24 hours) into its equation, just to make sure access is not removed sooner than a Customer might expect.</em></p>'."\n"; |
| 518 |
echo '<p><strong>See also:</strong> This KB article: <a href="http://www.s2member.com/kb/building-an-api-notification-handler/" target="_blank" rel="external">Building An API Notification Handler</a>.</p>'."\n"; |
| 519 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_during_cancellation_notifications", get_defined_vars()); |
| 520 |
|
| 521 |
echo '<table class="form-table">'."\n"; |
| 522 |
echo '<tbody>'."\n"; |
| 523 |
echo '<tr>'."\n"; |
| 524 |
|
| 525 |
echo '<th>'."\n"; |
| 526 |
echo '<label for="ws-plugin--s2member-cancellation-notification-urls">'."\n"; |
| 527 |
echo 'Cancellation Notification URLs:'."\n"; |
| 528 |
echo '</label>'."\n"; |
| 529 |
echo '</th>'."\n"; |
| 530 |
|
| 531 |
echo '</tr>'."\n"; |
| 532 |
echo '<tr>'."\n"; |
| 533 |
|
| 534 |
echo '<td>'."\n"; |
| 535 |
echo 'You can input multiple Notification URLs by inserting one per line.<br />'."\n"; |
| 536 |
echo '<textarea name="ws_plugin__s2member_cancellation_notification_urls" id="ws-plugin--s2member-cancellation-notification-urls" rows="3" wrap="off">'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["cancellation_notification_urls"]).'</textarea><br />'."\n"; |
| 537 |
echo 'Cancellation Notifications take place silently behind-the-scenes, using an HTTP connection.<br /><br />'."\n"; |
| 538 |
echo '<strong>You can also use these special Replacement Codes if you need them:</strong>'."\n"; |
| 539 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 540 |
echo '<li><code>%%subscr_id%%</code> = The Paid Subscription ID, which remained constant throughout the lifetime of the Membership. [ <a href="#" onclick="alert(\'There is one exception. If you are selling Lifetime or Fixed-Term (non-recurring) access, using Buy Now functionality; the %%subscr_id%% is actually set to the original Transaction ID for the purchase. Payment Gateways do not provide a specific Subscription ID for Buy Now purchases. Since Lifetime & Fixed-Term Subscriptions are NOT recurring (i.e., there was only ONE payment), using the Transaction ID as the Subscription ID is a graceful way to deal with this minor conflict.\'); return false;">?</a> ]</li>'."\n"; |
| 541 |
echo '<li><code>%%subscr_baid%%</code> = Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that required a Billing Agreement. This is the Subscription\'s Billing Agreement ID, which remained constant throughout the lifetime of the Membership. [ <a href="#" onclick="alert(\'Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that required a Billing Agreement. In all other cases, the %%subscr_baid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% in most cases.\'); return false;">?</a> ]</li>'."\n"; |
| 542 |
echo '<li><code>%%subscr_cid%%</code> = Applicable only with Stripe integration. This is the Customer\'s ID in Stripe, which remained constant throughout the lifetime of the Membership. Each Stripe Customer has this Customer ID; and also a Subscription and/or Transaction ID [ <a href="#" onclick="alert(\'Applicable only when you integrate s2Member with Stripe. In all other cases, the %%subscr_cid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% when running anything other than Stripe.\\n\\nEach Stripe Customer has a Customer ID; and also a Subscription and/or Transaction ID. See %%subscr_id%% for further details.\'); return false;">?</a> ]</li>'."\n"; |
| 543 |
echo '<li><code>%%item_number%%</code> = The Item Number (colon separated <em>level:custom_capabilities:fixed term</em>) that the Subscription was for.</li>'."\n"; |
| 544 |
echo '<li><code>%%item_name%%</code> = The Item Name (as provided by the <code>desc=""</code> attribute in your Shortcode, which briefly describes the Item Number).</li>'."\n"; |
| 545 |
echo '<li><code>%%user_first_name%%</code> = The First Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 546 |
echo '<li><code>%%user_last_name%%</code> = The Last Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 547 |
echo '<li><code>%%user_full_name%%</code> = The Full Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 548 |
echo '<li><code>%%user_email%%</code> = The Email Address associated with their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 549 |
echo '<li><code>%%user_login%%</code> = The Username associated with their account. The Customer created this during registration.</li>'."\n"; |
| 550 |
echo '<li><code>%%user_ip%%</code> = The Customer\'s original IP Address, during checkout/registration via <code>$_SERVER["REMOTE_ADDR"]</code>.</li>'."\n"; |
| 551 |
echo '<li><code>%%user_id%%</code> = A unique WordPress User ID that references this account in the WordPress database.</li>'."\n"; |
| 552 |
echo '</ul>'."\n"; |
| 553 |
|
| 554 |
echo '<strong>Custom Registration/Profile Fields are also supported in this Notification:</strong>'."\n"; |
| 555 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 556 |
echo '<li><code>%%date_of_birth%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>date_of_birth</code>.</li>'."\n"; |
| 557 |
echo '<li><code>%%street_address%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>street_address</code>.</li>'."\n"; |
| 558 |
echo '<li><code>%%country%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>country</code>.</li>'."\n"; |
| 559 |
echo '<li><em><code>%%etc, etc...%%</code> <strong>see:</strong> s2Member → General Options → Registration/Profile Fields</em>.</li>'."\n"; |
| 560 |
echo '</ul>'."\n"; |
| 561 |
|
| 562 |
echo '<strong>Custom Replacement Codes can also be inserted using these instructions:</strong>'."\n"; |
| 563 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 564 |
echo '<li><code>%%cv0%%</code> = The domain of your site, which is passed through the `custom` attribute in your Shortcode.</li>'."\n"; |
| 565 |
echo '<li><code>%%cv1%%</code> = If you need to track additional custom variables, you can pipe delimit them into the `custom` attribute; inside your Shortcode, like this: <code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|cv1|cv2|cv3"</code>. You can have an unlimited number of custom variables. Obviously, this is for advanced webmasters; but the functionality has been made available for those who need it.</li>'."\n"; |
| 566 |
echo '</ul>'."\n"; |
| 567 |
echo '<strong>This example uses cv1 to record a special marketing campaign:</strong><br />'."\n"; |
| 568 |
echo '<em>(The campaign (i.e., christmas-promo) could be referenced using <code>%%cv1%%</code>)</em><br />'."\n"; |
| 569 |
echo '<code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|christmas-promo"</code>'."\n"; |
| 570 |
|
| 571 |
echo '</td>'."\n"; |
| 572 |
|
| 573 |
echo '</tr>'."\n"; |
| 574 |
echo '</tbody>'."\n"; |
| 575 |
echo '</table>'."\n"; |
| 576 |
|
| 577 |
echo '<div class="ws-menu-page-hr"></div>'."\n"; |
| 578 |
|
| 579 |
echo '<table class="form-table" style="margin-top:0;">'."\n"; |
| 580 |
echo '<tbody>'."\n"; |
| 581 |
echo '<tr>'."\n"; |
| 582 |
|
| 583 |
echo '<th style="padding-top:0;">'."\n"; |
| 584 |
echo '<label for="ws-plugin--s2member-cancellation-notification-recipients">'."\n"; |
| 585 |
echo 'Send An Email Transaction Log Of This Event?'."\n"; |
| 586 |
echo '</label>'."\n"; |
| 587 |
echo '</th>'."\n"; |
| 588 |
|
| 589 |
echo '</tr>'."\n"; |
| 590 |
echo '<tr>'."\n"; |
| 591 |
|
| 592 |
echo '<td>'."\n"; |
| 593 |
echo '<input type="text" autocomplete="off" name="ws_plugin__s2member_cancellation_notification_recipients" id="ws-plugin--s2member-cancellation-notification-recipients" value="'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["cancellation_notification_recipients"]).'" /><br />'."\n"; |
| 594 |
echo 'This is a semicolon ( ; ) delimited list of Recipients. Here is an example:<br />'."\n"; |
| 595 |
echo '<code>"John" <john@example.com>; admin@example.com; "Webmaster" <webmaster@example.com></code>'."\n"; |
| 596 |
echo '</td>'."\n"; |
| 597 |
|
| 598 |
echo '</tr>'."\n"; |
| 599 |
echo '</tbody>'."\n"; |
| 600 |
echo '</table>'."\n"; |
| 601 |
echo '</div>'."\n"; |
| 602 |
|
| 603 |
echo '</div>'."\n"; |
| 604 |
|
| 605 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_after_cancellation_notifications", get_defined_vars()); |
| 606 |
} |
| 607 |
|
| 608 |
if(apply_filters("ws_plugin__s2member_during_api_ops_page_during_left_sections_display_eot_deletion_notifications", TRUE, get_defined_vars())) |
| 609 |
{ |
| 610 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_before_eot_deletion_notifications", get_defined_vars()); |
| 611 |
|
| 612 |
echo '<div class="ws-menu-page-group" title="EOT/Deletion Notifications">'."\n"; |
| 613 |
|
| 614 |
echo '<div class="ws-menu-page-section ws-plugin--s2member-eot-deletion-notifications-section">'."\n"; |
| 615 |
echo '<h3>EOT/Deletion Notification URLs (optional)</h3>'."\n"; |
| 616 |
echo '<p>If you use affiliate software, or have back-office routines that need to be notified whenever Subscriptions have ended <em>(and a Member is demoted according to your EOT settings)</em>, or when an account is deleted from the system, you\'ll want to read this section. This is marked `EOT/Deletion`, because the URLs that you list below, will be notified in both cases.</p>'."\n"; |
| 617 |
echo '<p><strong>EOT = End Of Term.</strong> An EOT is triggered <em>immediately</em> when you refund a Customer, when a Customer forces a chargeback to occur, or when a paid Subscription ends naturally <em>(i.e., expires)</em>, and your Payment Gateway sends s2Member an EOT (End Of Term) response. Delayed EOTs occur after a Cancellation, either as a result of you cancelling a Customer\'s Subscription, or a Customer cancelling their own Subscription. A Cancellation usually results in a delayed EOT, because a Cancellation does NOT always warrant an immediate action; there could still be time left on their Subscription.</p>'."\n"; |
| 618 |
echo '<p>Manual Deletions will trigger this Notification too. If you delete an account manually from within your WordPress Dashboard, your URLs can be notified automatically through this API Notification, and this scenario can be detected through the Replacement Code <code>%%eot_del_type%%</code>, which is documented below. So the two events are an EOT <em>(of any kind)</em> and/or a Manual Deletion.</p>'."\n"; |
| 619 |
echo '<p>Please note, this feature is not to be confused with the PayPal IPN service. PayPal IPN <em>(and other service integrations)</em> are already built into s2Member. They remain active at all times. These EOT/Deletion Notifications are an added layer of functionality, and they are completely optional.</p>'."\n"; |
| 620 |
echo '<p><em><strong>Some Hairy Details:</strong> There might be times whenever you notice that a Member\'s Subscription has been cancelled through your Payment Gateway... but, s2Member continues allowing the User access to your site as a paid Member. Please don\'t be confused by this... in 99.9% of these cases, the reason for this is legitimate. s2Member will only process the membership EOT when an EOT (End Of Term) is reached, a refund occurs, a chargeback occurs, or when a cancellation later results in a delayed Auto-EOT by s2Member.</em></p>'."\n"; |
| 621 |
echo '<p><em>s2Member will not process an EOT (End Of Term) until the User has completely used up the time they paid for. In other words, if a User signs up for a monthly Subscription on Jan 1st, and then cancels their Subscription on Jan 15th; technically, they should still be allowed to access the site for another 15 days, and then on Feb 1st, the time they paid for has completely elapsed. At that time, s2Member will process their membership EOT by either assigning the role selected under Demote To Role or applying the configured Delete behavior. s2Member also calculates one extra day (24 hours) into its equation, just to make sure access is not removed sooner than a Customer might expect.</em></p>'."\n"; |
| 622 |
echo '<p><strong>See also:</strong> This KB article: <a href="http://www.s2member.com/kb/building-an-api-notification-handler/" target="_blank" rel="external">Building An API Notification Handler</a>.</p>'."\n"; |
| 623 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_during_eot_deletion_notifications", get_defined_vars()); |
| 624 |
|
| 625 |
echo '<table class="form-table">'."\n"; |
| 626 |
echo '<tbody>'."\n"; |
| 627 |
echo '<tr>'."\n"; |
| 628 |
|
| 629 |
echo '<th>'."\n"; |
| 630 |
echo '<label for="ws-plugin--s2member-eot-del-notification-urls">'."\n"; |
| 631 |
echo 'EOT/Deletion Notification URLs:'."\n"; |
| 632 |
echo '</label>'."\n"; |
| 633 |
echo '</th>'."\n"; |
| 634 |
|
| 635 |
echo '</tr>'."\n"; |
| 636 |
echo '<tr>'."\n"; |
| 637 |
|
| 638 |
echo '<td>'."\n"; |
| 639 |
echo 'You can input multiple Notification URLs by inserting one per line.<br />'."\n"; |
| 640 |
echo '<textarea name="ws_plugin__s2member_eot_del_notification_urls" id="ws-plugin--s2member-eot-del-notification-urls" rows="3" wrap="off">'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["eot_del_notification_urls"]).'</textarea><br />'."\n"; |
| 641 |
echo 'EOT/Deletion Notifications take place silently behind-the-scenes, using an HTTP connection.<br /><br />'."\n"; |
| 642 |
echo '<strong>You can also use these special Replacement Codes if you need them:</strong>'."\n"; |
| 643 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 644 |
echo '<li><code>%%eot_del_type%%</code> = The type of event that triggered this Notification. [ <a href="#" onclick="alert(\'List of possible values:\\n\\nuser-removal-deletion (i.e., manual removal/deletion)\\nauto-eot-cancellation-expiration-demotion\\nauto-eot-cancellation-expiration-deletion\\nipn-cancellation-expiration-demotion\\nipn-cancellation-expiration-deletion\\nipn-refund-reversal-demotion\\nipn-refund-reversal-deletion\'); return false;">list of possible values</a> ]</li>'."\n"; |
| 645 |
echo '<li><code>%%subscr_id%%</code> = The Paid Subscription ID, which remained constant throughout the lifetime of the Membership. [ <a href="#" onclick="alert(\'There is one exception. If you are selling Lifetime or Fixed-Term (non-recurring) access, using Buy Now functionality; the %%subscr_id%% is actually set to the original Transaction ID for the purchase. Payment Gateways do not provide a specific Subscription ID for Buy Now purchases. Since Lifetime & Fixed-Term Subscriptions are NOT recurring (i.e., there was only ONE payment), using the Transaction ID as the Subscription ID is a graceful way to deal with this minor conflict.\'); return false;">?</a> ]</li>'."\n"; |
| 646 |
echo '<li><code>%%subscr_baid%%</code> = Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that required a Billing Agreement. This is the Subscription\'s Billing Agreement ID, which remained constant throughout the lifetime of the Membership. [ <a href="#" onclick="alert(\'Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that required a Billing Agreement. In all other cases, the %%subscr_baid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% in most cases.\'); return false;">?</a> ]</li>'."\n"; |
| 647 |
echo '<li><code>%%subscr_cid%%</code> = Applicable only with Stripe integration. This is the Customer\'s ID in Stripe, which remained constant throughout the lifetime of the Membership. Each Stripe Customer has this Customer ID; and also a Subscription and/or Transaction ID [ <a href="#" onclick="alert(\'Applicable only when you integrate s2Member with Stripe. In all other cases, the %%subscr_cid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% when running anything other than Stripe.\\n\\nEach Stripe Customer has a Customer ID; and also a Subscription and/or Transaction ID. See %%subscr_id%% for further details.\'); return false;">?</a> ]</li>'."\n"; |
| 648 |
echo '<li><code>%%user_first_name%%</code> = The First Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 649 |
echo '<li><code>%%user_last_name%%</code> = The Last Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 650 |
echo '<li><code>%%user_full_name%%</code> = The Full Name listed on their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 651 |
echo '<li><code>%%user_email%%</code> = The Email Address associated with their User account. This might be different than what is on file with your Payment Gateway.</li>'."\n"; |
| 652 |
echo '<li><code>%%user_login%%</code> = The Username associated with their account. The Customer created this during registration.</li>'."\n"; |
| 653 |
echo '<li><code>%%user_ip%%</code> = The Customer\'s original IP Address, during checkout/registration via <code>$_SERVER["REMOTE_ADDR"]</code>.</li>'."\n"; |
| 654 |
echo '<li><code>%%user_id%%</code> = A unique WordPress User ID that references this account in the WordPress database.</li>'."\n"; |
| 655 |
echo '</ul>'."\n"; |
| 656 |
|
| 657 |
echo '<strong>Custom Registration/Profile Fields are also supported in this Notification:</strong>'."\n"; |
| 658 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 659 |
echo '<li><code>%%date_of_birth%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>date_of_birth</code>.</li>'."\n"; |
| 660 |
echo '<li><code>%%street_address%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>street_address</code>.</li>'."\n"; |
| 661 |
echo '<li><code>%%country%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>country</code>.</li>'."\n"; |
| 662 |
echo '<li><em><code>%%etc, etc...%%</code> <strong>see:</strong> s2Member → General Options → Registration/Profile Fields</em>.</li>'."\n"; |
| 663 |
echo '</ul>'."\n"; |
| 664 |
|
| 665 |
echo '<strong>Custom Replacement Codes can also be inserted using these instructions:</strong>'."\n"; |
| 666 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 667 |
echo '<li><code>%%cv0%%</code> = The domain of your site, which is passed through the `custom` attribute in your Shortcode.</li>'."\n"; |
| 668 |
echo '<li><code>%%cv1%%</code> = If you need to track additional custom variables, you can pipe delimit them into the `custom` attribute; inside your Shortcode, like this: <code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|cv1|cv2|cv3"</code>. You can have an unlimited number of custom variables. Obviously, this is for advanced webmasters; but the functionality has been made available for those who need it.</li>'."\n"; |
| 669 |
echo '</ul>'."\n"; |
| 670 |
echo '<strong>This example uses cv1 to record a special marketing campaign:</strong><br />'."\n"; |
| 671 |
echo '<em>(The campaign (i.e., christmas-promo) could be referenced using <code>%%cv1%%</code>)</em><br />'."\n"; |
| 672 |
echo '<code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|christmas-promo"</code>'."\n"; |
| 673 |
|
| 674 |
echo '</td>'."\n"; |
| 675 |
|
| 676 |
echo '</tr>'."\n"; |
| 677 |
echo '</tbody>'."\n"; |
| 678 |
echo '</table>'."\n"; |
| 679 |
|
| 680 |
echo '<div class="ws-menu-page-hr"></div>'."\n"; |
| 681 |
|
| 682 |
echo '<table class="form-table" style="margin-top:0;">'."\n"; |
| 683 |
echo '<tbody>'."\n"; |
| 684 |
echo '<tr>'."\n"; |
| 685 |
|
| 686 |
echo '<th style="padding-top:0;">'."\n"; |
| 687 |
echo '<label for="ws-plugin--s2member-eot-del-notification-recipients">'."\n"; |
| 688 |
echo 'Send An Email Transaction Log Of This Event?'."\n"; |
| 689 |
echo '</label>'."\n"; |
| 690 |
echo '</th>'."\n"; |
| 691 |
|
| 692 |
echo '</tr>'."\n"; |
| 693 |
echo '<tr>'."\n"; |
| 694 |
|
| 695 |
echo '<td>'."\n"; |
| 696 |
echo '<input type="text" autocomplete="off" name="ws_plugin__s2member_eot_del_notification_recipients" id="ws-plugin--s2member-eot-del-notification-recipients" value="'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["eot_del_notification_recipients"]).'" /><br />'."\n"; |
| 697 |
echo 'This is a semicolon ( ; ) delimited list of Recipients. Here is an example:<br />'."\n"; |
| 698 |
echo '<code>"John" <john@example.com>; admin@example.com; "Webmaster" <webmaster@example.com></code>'."\n"; |
| 699 |
echo '</td>'."\n"; |
| 700 |
|
| 701 |
echo '</tr>'."\n"; |
| 702 |
echo '</tbody>'."\n"; |
| 703 |
echo '</table>'."\n"; |
| 704 |
echo '</div>'."\n"; |
| 705 |
|
| 706 |
echo '</div>'."\n"; |
| 707 |
|
| 708 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_after_eot_deletion_notifications", get_defined_vars()); |
| 709 |
} |
| 710 |
|
| 711 |
if(apply_filters("ws_plugin__s2member_during_api_ops_page_during_left_sections_display_refund_reversal_notifications", TRUE, get_defined_vars())) |
| 712 |
{ |
| 713 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_before_refund_reversal_notifications", get_defined_vars()); |
| 714 |
|
| 715 |
echo '<div class="ws-menu-page-group" title="Refund/Reversal Notifications">'."\n"; |
| 716 |
|
| 717 |
echo '<div class="ws-menu-page-section ws-plugin--s2member-refund-reversal-notifications-section">'."\n"; |
| 718 |
echo '<h3>Refund/Reversal Notification URLs (optional)</h3>'."\n"; |
| 719 |
echo '<p>If you use affiliate software, or have back-office routines that need to be notified whenever Subscriptions have been refunded or reversed <em>(i.e., charged back to you)</em>, you\'ll want to read this section. This is marked `Refund/Reversal`, because the URLs that you list below, will ONLY be notified in those specific cases, as opposed to EOT/Deletion Notifications, which are all-inclusive.</p>'."\n"; |
| 720 |
echo '<p>This is very similar to the EOT/Deletion Notification described above. However, there is an important distinction. The all-inclusive EOT/Deletion Notification includes cancellations, expirations, failed payments, refunds, chargebacks, and even manual deletions by the Administrator from within the Dashboard. In other words, EOT/Deletion Notifications are processed ANY time a deletion or End Of Term action takes place. This API Notification, that is, Refund/Reversal Notifications, do NOT include all of those scenarios.</p>'."\n"; |
| 721 |
echo '<p>So the distinction is that Refund/Reversal Notifications are ONLY sent under two specific circumstances: 1. You log into your Payment Gateway and refund a payment that is associated with a Subscription. 2. The Customer complains to your Payment Gateway and a chargeback occurs, forcing a Reversal. In both of these cases, an EOT/Deletion Notification will be sent <em>(as described in the previous section)</em>, but since EOT/Deletion is a broader Notification, these Refund/Reversal Notifications are here so you can nail down specific back-office operations in these two specific scenarios.</p>'."\n"; |
| 722 |
echo '<p>Please note, this feature is not to be confused with the PayPal IPN service. PayPal IPN <em>(and other service integrations)</em> are already built into s2Member. They remain active at all times. These Refund/Reversal Notifications are an added layer of functionality, and they are completely optional.</p>'."\n"; |
| 723 |
echo '<p><strong>See also:</strong> This KB article: <a href="http://www.s2member.com/kb/building-an-api-notification-handler/" target="_blank" rel="external">Building An API Notification Handler</a>.</p>'."\n"; |
| 724 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_during_refund_reversal_notifications", get_defined_vars()); |
| 725 |
|
| 726 |
echo '<table class="form-table">'."\n"; |
| 727 |
echo '<tbody>'."\n"; |
| 728 |
echo '<tr>'."\n"; |
| 729 |
|
| 730 |
echo '<th>'."\n"; |
| 731 |
echo '<label for="ws-plugin--s2member-ref-rev-notification-urls">'."\n"; |
| 732 |
echo 'Refund/Reversal Notification URLs:'."\n"; |
| 733 |
echo '</label>'."\n"; |
| 734 |
echo '</th>'."\n"; |
| 735 |
|
| 736 |
echo '</tr>'."\n"; |
| 737 |
echo '<tr>'."\n"; |
| 738 |
|
| 739 |
echo '<td>'."\n"; |
| 740 |
echo 'You can input multiple Notification URLs by inserting one per line.<br />'."\n"; |
| 741 |
echo '<textarea name="ws_plugin__s2member_ref_rev_notification_urls" id="ws-plugin--s2member-ref-rev-notification-urls" rows="3" wrap="off">'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["ref_rev_notification_urls"]).'</textarea><br />'."\n"; |
| 742 |
echo 'Refund/Reversal Notifications take place silently behind-the-scenes, using an HTTP connection.<br /><br />'."\n"; |
| 743 |
echo '<strong>You can also use these special Replacement Codes if you need them:</strong>'."\n"; |
| 744 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 745 |
echo '<li><code>%%subscr_id%%</code> = The Paid Subscription ID, which remained constant throughout the lifetime of the Membership. [ <a href="#" onclick="alert(\'There is one exception. If you are selling Lifetime or Fixed-Term (non-recurring) access, using Buy Now functionality; the %%subscr_id%% is actually set to the original Transaction ID for the purchase. Payment Gateways do not provide a specific Subscription ID for Buy Now purchases. Since Lifetime & Fixed-Term Subscriptions are NOT recurring (i.e., there was only ONE payment), using the Transaction ID as the Subscription ID is a graceful way to deal with this minor conflict.\'); return false;">?</a> ]</li>'."\n"; |
| 746 |
echo '<li><code>%%subscr_baid%%</code> = Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that required a Billing Agreement. This is the Subscription\'s Billing Agreement ID, which remained constant throughout the lifetime of the Membership. [ <a href="#" onclick="alert(\'Applicable only with PayPal Pro (Payflow Edition); and only for Express Checkout transactions that required a Billing Agreement. In all other cases, the %%subscr_baid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% in most cases.\'); return false;">?</a> ]</li>'."\n"; |
| 747 |
echo '<li><code>%%subscr_cid%%</code> = Applicable only with Stripe integration. This is the Customer\'s ID in Stripe, which remained constant throughout the lifetime of the Membership. Each Stripe Customer has this Customer ID; and also a Subscription and/or Transaction ID [ <a href="#" onclick="alert(\'Applicable only when you integrate s2Member with Stripe. In all other cases, the %%subscr_cid%% is simply set to the %%subscr_id%% value; i.e., it is a duplicate of %%subscr_id%% when running anything other than Stripe.\\n\\nEach Stripe Customer has a Customer ID; and also a Subscription and/or Transaction ID. See %%subscr_id%% for further details.\'); return false;">?</a> ]</li>'."\n"; |
| 748 |
echo '<li><code>%%parent_txn_id%%</code> = The Parent Transaction ID, associated with the original payment being refunded/reversed.</li>'."\n"; |
| 749 |
echo '<li><code>%%currency%%</code> = Three-character currency code (uppercase); e.g., <code>USD</code></li>'."\n"; |
| 750 |
echo '<li><code>%%currency_symbol%%</code> = Currency code symbol; e.g., <code>$</code></li>'."\n"; |
| 751 |
echo '<li><code>%%-amount%%</code> = The Negative Amount of the payment, that was refunded or reversed back to the Customer.</li>'."\n"; |
| 752 |
echo '<li><code>%%-fee%%</code> = The Negative Payment Gateway fee, that was refunded back to you as the Merchant/Seller.</li>'."\n"; |
| 753 |
echo '<li><code>%%first_name%%</code> = The First Name of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 754 |
echo '<li><code>%%last_name%%</code> = The Last Name of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 755 |
echo '<li><code>%%full_name%%</code> = The Full Name (First & Last) of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 756 |
echo '<li><code>%%payer_email%%</code> = The Email Address of the Customer who purchased the Membership Subscription.</li>'."\n"; |
| 757 |
echo '<li><code>%%item_number%%</code> = The Item Number (colon separated <em>level:custom_capabilities:fixed term</em>) that the payment was for.</li>'."\n"; |
| 758 |
echo '<li><code>%%item_name%%</code> = The Item Name (as provided by the <code>desc=""</code> attribute in your Shortcode, which briefly describes the Item Number).</li>'."\n"; |
| 759 |
echo '<li><code>%%user_ip%%</code> = The Customer\'s original IP Address, during checkout/registration via <code>$_SERVER["REMOTE_ADDR"]</code>.</li>'."\n"; |
| 760 |
echo '<li><code>%%user_id%%</code> = A unique WordPress User ID that references this account in the WordPress database.</li>'."\n"; |
| 761 |
echo '</ul>'."\n"; |
| 762 |
|
| 763 |
echo '<strong>Custom Registration/Profile Fields are also supported in this Notification:</strong>'."\n"; |
| 764 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 765 |
echo '<li><code>%%date_of_birth%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>date_of_birth</code>.</li>'."\n"; |
| 766 |
echo '<li><code>%%street_address%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>street_address</code>.</li>'."\n"; |
| 767 |
echo '<li><code>%%country%%</code> would be valid; if you have a Custom Registration/Profile Field with the ID <code>country</code>.</li>'."\n"; |
| 768 |
echo '<li><em><code>%%etc, etc...%%</code> <strong>see:</strong> s2Member → General Options → Registration/Profile Fields</em>.</li>'."\n"; |
| 769 |
echo '</ul>'."\n"; |
| 770 |
|
| 771 |
echo '<strong>Custom Replacement Codes can also be inserted using these instructions:</strong>'."\n"; |
| 772 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 773 |
echo '<li><code>%%cv0%%</code> = The domain of your site, which is passed through the `custom` attribute in your Shortcode.</li>'."\n"; |
| 774 |
echo '<li><code>%%cv1%%</code> = If you need to track additional custom variables, you can pipe delimit them into the `custom` attribute; inside your Shortcode, like this: <code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|cv1|cv2|cv3"</code>. You can have an unlimited number of custom variables. Obviously, this is for advanced webmasters; but the functionality has been made available for those who need it.</li>'."\n"; |
| 775 |
echo '</ul>'."\n"; |
| 776 |
echo '<strong>This example uses cv1 to record a special marketing campaign:</strong><br />'."\n"; |
| 777 |
echo '<em>(The campaign (i.e., christmas-promo) could be referenced using <code>%%cv1%%</code>)</em><br />'."\n"; |
| 778 |
echo '<code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|christmas-promo"</code>'."\n"; |
| 779 |
|
| 780 |
echo '</td>'."\n"; |
| 781 |
|
| 782 |
echo '</tr>'."\n"; |
| 783 |
echo '</tbody>'."\n"; |
| 784 |
echo '</table>'."\n"; |
| 785 |
|
| 786 |
echo '<div class="ws-menu-page-hr"></div>'."\n"; |
| 787 |
|
| 788 |
echo '<table class="form-table" style="margin-top:0;">'."\n"; |
| 789 |
echo '<tbody>'."\n"; |
| 790 |
echo '<tr>'."\n"; |
| 791 |
|
| 792 |
echo '<th style="padding-top:0;">'."\n"; |
| 793 |
echo '<label for="ws-plugin--s2member-ref-rev-notification-recipients">'."\n"; |
| 794 |
echo 'Send An Email Transaction Log Of This Event?'."\n"; |
| 795 |
echo '</label>'."\n"; |
| 796 |
echo '</th>'."\n"; |
| 797 |
|
| 798 |
echo '</tr>'."\n"; |
| 799 |
echo '<tr>'."\n"; |
| 800 |
|
| 801 |
echo '<td>'."\n"; |
| 802 |
echo '<input type="text" autocomplete="off" name="ws_plugin__s2member_ref_rev_notification_recipients" id="ws-plugin--s2member-ref-rev-notification-recipients" value="'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["ref_rev_notification_recipients"]).'" /><br />'."\n"; |
| 803 |
echo 'This is a semicolon ( ; ) delimited list of Recipients. Here is an example:<br />'."\n"; |
| 804 |
echo '<code>"John" <john@example.com>; admin@example.com; "Webmaster" <webmaster@example.com></code>'."\n"; |
| 805 |
echo '</td>'."\n"; |
| 806 |
|
| 807 |
echo '</tr>'."\n"; |
| 808 |
echo '</tbody>'."\n"; |
| 809 |
echo '</table>'."\n"; |
| 810 |
echo '</div>'."\n"; |
| 811 |
|
| 812 |
echo '</div>'."\n"; |
| 813 |
|
| 814 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_after_refund_reversal_notifications", get_defined_vars()); |
| 815 |
} |
| 816 |
|
| 817 |
if(apply_filters("ws_plugin__s2member_during_api_ops_page_during_left_sections_display_sp_sale_notifications", TRUE, get_defined_vars())) |
| 818 |
{ |
| 819 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_before_sp_sale_notifications", get_defined_vars()); |
| 820 |
|
| 821 |
echo '<div class="ws-menu-page-group" title="Specific Post/Page ~ Sale Notifications">'."\n"; |
| 822 |
|
| 823 |
echo '<div class="ws-menu-page-section ws-plugin--s2member-sp-sale-notifications-section">'."\n"; |
| 824 |
echo '<h3>Specific Post/Page ~ Sale Notification URLs (optional)</h3>'."\n"; |
| 825 |
echo '<p>If you use affiliate software, or have back-office routines that need to be notified whenever Specific Post/Page sales take place, you\'ll want to read this section. This is marked `Specific Post/Page`, because the URLs that you list below, will be notified each time a payment occurs, on a sale providing access to a Specific Post/Page.</p>'."\n"; |
| 826 |
echo '<p>This is one of only two API Notifications that are sent for Specific Post/Page Access <em>(i.e., this one, and another below, for Refunds/Reversals)</em>. All of the other API Notifications are designed for Membership Level Access'.((is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site()) ? '' : ' and Independent Custom Capabilities').'. None of the other API Notifications will ever be processed for Specific Post/Page Access. If you intend to respond to events related to Specific Post/Page Access, you MUST use one of the two API Notifications specifically geared to Post/Page Access.</p>'."\n"; |
| 827 |
echo '<p>Please note, this feature is not to be confused with the PayPal IPN service. PayPal IPN <em>(and other service integrations)</em> are already built into s2Member. They remain active at all times. These Sale Notifications are an added layer of functionality, and they are completely optional.</p>'."\n"; |
| 828 |
echo '<p><strong>See also:</strong> This KB article: <a href="http://www.s2member.com/kb/building-an-api-notification-handler/" target="_blank" rel="external">Building An API Notification Handler</a>.</p>'."\n"; |
| 829 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_during_sp_sale_notifications", get_defined_vars()); |
| 830 |
|
| 831 |
echo '<table class="form-table">'."\n"; |
| 832 |
echo '<tbody>'."\n"; |
| 833 |
echo '<tr>'."\n"; |
| 834 |
|
| 835 |
echo '<th>'."\n"; |
| 836 |
echo '<label for="ws-plugin--s2member-sp-sale-notification-urls">'."\n"; |
| 837 |
echo 'Specific Post/Page ~ Sale Notification URLs:'."\n"; |
| 838 |
echo '</label>'."\n"; |
| 839 |
echo '</th>'."\n"; |
| 840 |
|
| 841 |
echo '</tr>'."\n"; |
| 842 |
echo '<tr>'."\n"; |
| 843 |
|
| 844 |
echo '<td>'."\n"; |
| 845 |
echo 'You can input multiple Notification URLs by inserting one per line.<br />'."\n"; |
| 846 |
echo '<textarea name="ws_plugin__s2member_sp_sale_notification_urls" id="ws-plugin--s2member-sp-sale-notification-urls" rows="3" wrap="off">'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["sp_sale_notification_urls"]).'</textarea><br />'."\n"; |
| 847 |
echo 'Specific Post/Page ~ Sale Notifications take place silently behind-the-scenes, using an HTTP connection.<br /><br />'."\n"; |
| 848 |
echo '<strong>You can also use these special Replacement Codes if you need them:</strong>'."\n"; |
| 849 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 850 |
echo '<li><code>%%sp_access_url%%</code> = The full URL (generated by s2Member) where the Customer can gain access.</li>'."\n"; |
| 851 |
echo '<li><code>%%sp_access_exp%%</code> = Human readable expiration for <code>%%sp_access_url%%</code>. Ex: <em>(link expires in <code>%%sp_access_exp%%</code>)</em>.</li>'."\n"; |
| 852 |
echo '<li><code>%%txn_id%%</code> = The Paid Transaction ID. Payment Gateways assign a unique identifier for every purchase.</li>'."\n"; |
| 853 |
echo '<li><code>%%txn_cid%%</code> = Applicable only with Stripe integration. This is the Customer\'s ID in Stripe. Each Stripe Customer has this Customer ID; and also a Transaction ID associated with their purchase of the Specific Post/Page [ <a href="#" onclick="alert(\'Applicable only when you integrate s2Member with Stripe. In all other cases, the %%txn_cid%% is simply set to the %%txn_id%% value; i.e., it is a duplicate of %%txn_id%% when running anything other than Stripe.\\n\\nEach Stripe Customer has a Customer ID; and also a Transaction ID. See %%txn_id%% for further details.\'); return false;">?</a> ]</li>'."\n"; |
| 854 |
echo '<li><code>%%currency%%</code> = Three-character currency code (uppercase); e.g., <code>USD</code></li>'."\n"; |
| 855 |
echo '<li><code>%%currency_symbol%%</code> = Currency code symbol; e.g., <code>$</code></li>'."\n"; |
| 856 |
echo '<li><code>%%amount%%</code> = The full Amount of the sale. If you offer something 100% free, this will be <code>0</code>.</li>'."\n"; |
| 857 |
echo '<li><code>%%first_name%%</code> = The First Name of the Customer who purchased Specific Post/Page Access.</li>'."\n"; |
| 858 |
echo '<li><code>%%last_name%%</code> = The Last Name of the Customer who purchased Specific Post/Page Access.</li>'."\n"; |
| 859 |
echo '<li><code>%%full_name%%</code> = The Full Name (First & Last) of the Customer who purchased Specific Post/Page Access.</li>'."\n"; |
| 860 |
echo '<li><code>%%payer_email%%</code> = The Email Address of the Customer who purchased Specific Post/Page Access.</li>'."\n"; |
| 861 |
echo '<li><code>%%user_ip%%</code> = The Customers\'s IP Address, during checkout via <code>$_SERVER["REMOTE_ADDR"]</code>.</li>'."\n"; |
| 862 |
echo '<li><code>%%item_number%%</code> = The Item Number. Ex: <code><em>sp:13,24,36:72</em></code> (translates to: <code><em>sp:comma-delimited IDs:expiration hours</em></code>).</li>'."\n"; |
| 863 |
echo '<li><code>%%item_name%%</code> = The Item Name (as provided by the <code>desc=""</code> attribute in your Shortcode, which briefly describes the Item Number).</li>'."\n"; |
| 864 |
echo '</ul>'."\n"; |
| 865 |
|
| 866 |
if(c_ws_plugin__s2member_utils_conds::pro_is_installed()) |
| 867 |
{ |
| 868 |
echo '<strong>Coupon Replacement Codes (applicable only w/ s2Member Pro-Forms):</strong>'."\n"; |
| 869 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 870 |
echo '<li><code>%%full_coupon_code%%</code> = A full Coupon Code—if one is accepted by your configuration of s2Member. This may indicate an Affiliate Coupon Code, which will include your Affiliate Suffix Chars too (i.e., the full Coupon Code).</li>'."\n"; |
| 871 |
echo '<li><code>%%coupon_code%%</code> = A Coupon Code—if one is accepted by your configuration of s2Member. This will NOT include any Affiliate Suffix Chars. This indicates the actual Coupon Code accepted by your configuration of s2Member (excluding any Affiliate ID).</li>'."\n"; |
| 872 |
echo '<li><code>%%coupon_affiliate_id%%</code> = This is the end of an Affiliate Coupon Code <em>(i.e., the referring affiliate\'s ID)</em>. This is only applicable if an Affiliate Coupon Code is accepted by your configuration of s2Member.</li>'."\n"; |
| 873 |
echo '</ul>'."\n"; |
| 874 |
} |
| 875 |
|
| 876 |
echo '<strong>Custom Replacement Codes can also be inserted using these instructions:</strong>'."\n"; |
| 877 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 878 |
echo '<li><code>%%cv0%%</code> = The domain of your site, which is passed through the `custom` attribute in your Shortcode.</li>'."\n"; |
| 879 |
echo '<li><code>%%cv1%%</code> = If you need to track additional custom variables, you can pipe delimit them into the `custom` attribute; inside your Shortcode, like this: <code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|cv1|cv2|cv3"</code>. You can have an unlimited number of custom variables. Obviously, this is for advanced webmasters; but the functionality has been made available for those who need it.</li>'."\n"; |
| 880 |
echo '</ul>'."\n"; |
| 881 |
echo '<strong>This example uses cv1 to record a special marketing campaign:</strong><br />'."\n"; |
| 882 |
echo '<em>(The campaign (i.e., christmas-promo) could be referenced using <code>%%cv1%%</code>)</em><br />'."\n"; |
| 883 |
echo '<code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|christmas-promo"</code>'."\n"; |
| 884 |
|
| 885 |
echo '</td>'."\n"; |
| 886 |
|
| 887 |
echo '</tr>'."\n"; |
| 888 |
echo '</tbody>'."\n"; |
| 889 |
echo '</table>'."\n"; |
| 890 |
|
| 891 |
echo '<div class="ws-menu-page-hr"></div>'."\n"; |
| 892 |
|
| 893 |
echo '<table class="form-table" style="margin-top:0;">'."\n"; |
| 894 |
echo '<tbody>'."\n"; |
| 895 |
echo '<tr>'."\n"; |
| 896 |
|
| 897 |
echo '<th style="padding-top:0;">'."\n"; |
| 898 |
echo '<label for="ws-plugin--s2member-sp-sale-notification-recipients">'."\n"; |
| 899 |
echo 'Send An Email Transaction Log Of This Event?'."\n"; |
| 900 |
echo '</label>'."\n"; |
| 901 |
echo '</th>'."\n"; |
| 902 |
|
| 903 |
echo '</tr>'."\n"; |
| 904 |
echo '<tr>'."\n"; |
| 905 |
|
| 906 |
echo '<td>'."\n"; |
| 907 |
echo '<input type="text" autocomplete="off" name="ws_plugin__s2member_sp_sale_notification_recipients" id="ws-plugin--s2member-sp-sale-notification-recipients" value="'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["sp_sale_notification_recipients"]).'" /><br />'."\n"; |
| 908 |
echo 'This is a semicolon ( ; ) delimited list of Recipients. Here is an example:<br />'."\n"; |
| 909 |
echo '<code>"John" <john@example.com>; admin@example.com; "Webmaster" <webmaster@example.com></code>'."\n"; |
| 910 |
echo '</td>'."\n"; |
| 911 |
|
| 912 |
echo '</tr>'."\n"; |
| 913 |
echo '</tbody>'."\n"; |
| 914 |
echo '</table>'."\n"; |
| 915 |
echo '</div>'."\n"; |
| 916 |
|
| 917 |
echo '</div>'."\n"; |
| 918 |
|
| 919 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_after_sp_sale_notifications", get_defined_vars()); |
| 920 |
} |
| 921 |
|
| 922 |
if(apply_filters("ws_plugin__s2member_during_api_ops_page_during_left_sections_display_sp_refund_reversal_notifications", TRUE, get_defined_vars())) |
| 923 |
{ |
| 924 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_before_sp_refund_reversal_notifications", get_defined_vars()); |
| 925 |
|
| 926 |
echo '<div class="ws-menu-page-group" title="Specific Post/Page ~ Refund/Reversal Notifications">'."\n"; |
| 927 |
|
| 928 |
echo '<div class="ws-menu-page-section ws-plugin--s2member-sp-refund-reversal-notifications-section">'."\n"; |
| 929 |
echo '<h3>Specific Post/Page ~ Refund/Reversal Notification URLs (optional)</h3>'."\n"; |
| 930 |
echo '<p>If you use affiliate software, or have back-office routines that need to be notified whenever sales have been refunded or reversed <em>(i.e., charged back to you)</em>, you\'ll want to read this section. This is marked `Specific Post/Page`, because the URLs that you list below, will be notified each time a Refund or Reversal occurs, on a sale that provided access to a Specific Post/Page.</p>'."\n"; |
| 931 |
echo '<p>This is one of only two Notifications that are sent for Specific Post/Page Access <em>(i.e., this one, and another above, for Sales)</em>. All of the other API Notifications are designed for Membership Level Access'.((is_multisite() && c_ws_plugin__s2member_utils_conds::is_multisite_farm() && !is_main_site()) ? '' : ' and Independent Custom Capabilities').'. None of the other API Notifications will ever be processed for Specific Post/Page Access. If you intend to respond to events related to Specific Post/Page Access, you MUST use one of the two API Notifications specifically geared to Post/Page Access.</p>'."\n"; |
| 932 |
echo '<p>Please note, this feature is not to be confused with the PayPal IPN service. PayPal IPN <em>(and other service integrations)</em> are already built into s2Member. They remain active at all times. These Refund/Reversal Notifications are an added layer of functionality, and they are completely optional.</p>'."\n"; |
| 933 |
echo '<p><strong>See also:</strong> This KB article: <a href="http://www.s2member.com/kb/building-an-api-notification-handler/" target="_blank" rel="external">Building An API Notification Handler</a>.</p>'."\n"; |
| 934 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_during_sp_refund_reversal_notifications", get_defined_vars()); |
| 935 |
|
| 936 |
echo '<table class="form-table">'."\n"; |
| 937 |
echo '<tbody>'."\n"; |
| 938 |
echo '<tr>'."\n"; |
| 939 |
|
| 940 |
echo '<th>'."\n"; |
| 941 |
echo '<label for="ws-plugin--s2member-sp-ref-rev-notification-urls">'."\n"; |
| 942 |
echo 'Specific Post/Page ~ Refund/Reversal Notification URLs:'."\n"; |
| 943 |
echo '</label>'."\n"; |
| 944 |
echo '</th>'."\n"; |
| 945 |
|
| 946 |
echo '</tr>'."\n"; |
| 947 |
echo '<tr>'."\n"; |
| 948 |
|
| 949 |
echo '<td>'."\n"; |
| 950 |
echo 'You can input multiple Notification URLs by inserting one per line.<br />'."\n"; |
| 951 |
echo '<textarea name="ws_plugin__s2member_sp_ref_rev_notification_urls" id="ws-plugin--s2member-sp-ref-rev-notification-urls" rows="3" wrap="off">'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["sp_ref_rev_notification_urls"]).'</textarea><br />'."\n"; |
| 952 |
echo 'Specific Post/Page ~ Refund/Reversal Notifications take place silently behind-the-scenes, using an HTTP connection.<br /><br />'."\n"; |
| 953 |
echo '<strong>You can also use these special Replacement Codes if you need them:</strong>'."\n"; |
| 954 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 955 |
echo '<li><code>%%parent_txn_id%%</code> = The Parent Transaction ID, associated with the original payment being refunded/reversed.</li>'."\n"; |
| 956 |
echo '<li><code>%%parent_txn_cid%%</code> = Applicable only with Stripe integration. This is the Customer\'s ID in Stripe. Each Stripe Customer has this Customer ID; and also a Transaction ID associated with their purchase of the Specific Post/Page [ <a href="#" onclick="alert(\'Applicable only when you integrate s2Member with Stripe. In all other cases, the %%parent_txn_cid%% is simply set to the %%parent_txn_id%% value; i.e., it is a duplicate of %%parent_txn_id%% when running anything other than Stripe.\\n\\nEach Stripe Customer has a Customer ID; and also a Transaction ID. See %%parent_txn_id%% for further details.\'); return false;">?</a> ]</li>'."\n"; |
| 957 |
echo '<li><code>%%currency%%</code> = Three-character currency code (uppercase); e.g., <code>USD</code></li>'."\n"; |
| 958 |
echo '<li><code>%%currency_symbol%%</code> = Currency code symbol; e.g., <code>$</code></li>'."\n"; |
| 959 |
echo '<li><code>%%-amount%%</code> = The Negative Amount of the payment, that was refunded or reversed back to the Customer.</li>'."\n"; |
| 960 |
echo '<li><code>%%-fee%%</code> = The Negative Payment Gateway fee, that was refunded back to you as the Merchant/Seller.</li>'."\n"; |
| 961 |
echo '<li><code>%%first_name%%</code> = The First Name of the Customer who purchased access to a Specific Post/Page.</li>'."\n"; |
| 962 |
echo '<li><code>%%last_name%%</code> = The Last Name of the Customer who purchased access to a Specific Post/Page.</li>'."\n"; |
| 963 |
echo '<li><code>%%full_name%%</code> = The Full Name (First & Last) of the Customer who purchased access to a Specific Post/Page.</li>'."\n"; |
| 964 |
echo '<li><code>%%payer_email%%</code> = The Email Address of the Customer who purchased access to a Specific Post/Page.</li>'."\n"; |
| 965 |
echo '<li><code>%%user_ip%%</code> = The Customer\'s original IP Address, during checkout via <code>$_SERVER["REMOTE_ADDR"]</code>.</li>'."\n"; |
| 966 |
echo '<li><code>%%item_number%%</code> = The Item Number. Ex: <code><em>sp:13,24,36:72</em></code> (translates to: <code><em>sp:comma-delimited IDs:expiration hours</em></code>).</li>'."\n"; |
| 967 |
echo '<li><code>%%item_name%%</code> = The Item Name (as provided by the <code>desc=""</code> attribute in your Shortcode, which briefly describes the Item Number).</li>'."\n"; |
| 968 |
echo '</ul>'."\n"; |
| 969 |
|
| 970 |
echo '<strong>Custom Replacement Codes can also be inserted using these instructions:</strong>'."\n"; |
| 971 |
echo '<ul class="ws-menu-page-li-margins">'."\n"; |
| 972 |
echo '<li><code>%%cv0%%</code> = The domain of your site, which is passed through the `custom` attribute in your Shortcode.</li>'."\n"; |
| 973 |
echo '<li><code>%%cv1%%</code> = If you need to track additional custom variables, you can pipe delimit them into the `custom` attribute; inside your Shortcode, like this: <code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|cv1|cv2|cv3"</code>. You can have an unlimited number of custom variables. Obviously, this is for advanced webmasters; but the functionality has been made available for those who need it.</li>'."\n"; |
| 974 |
echo '</ul>'."\n"; |
| 975 |
echo '<strong>This example uses cv1 to record a special marketing campaign:</strong><br />'."\n"; |
| 976 |
echo '<em>(The campaign (i.e., christmas-promo) could be referenced using <code>%%cv1%%</code>)</em><br />'."\n"; |
| 977 |
echo '<code>custom="'.esc_html($_SERVER["HTTP_HOST"]).'|christmas-promo"</code>'."\n"; |
| 978 |
|
| 979 |
echo '</td>'."\n"; |
| 980 |
|
| 981 |
echo '</tr>'."\n"; |
| 982 |
echo '</tbody>'."\n"; |
| 983 |
echo '</table>'."\n"; |
| 984 |
|
| 985 |
echo '<div class="ws-menu-page-hr"></div>'."\n"; |
| 986 |
|
| 987 |
echo '<table class="form-table" style="margin-top:0;">'."\n"; |
| 988 |
echo '<tbody>'."\n"; |
| 989 |
echo '<tr>'."\n"; |
| 990 |
|
| 991 |
echo '<th style="padding-top:0;">'."\n"; |
| 992 |
echo '<label for="ws-plugin--s2member-sp-ref-rev-notification-recipients">'."\n"; |
| 993 |
echo 'Send An Email Transaction Log Of This Event?'."\n"; |
| 994 |
echo '</label>'."\n"; |
| 995 |
echo '</th>'."\n"; |
| 996 |
|
| 997 |
echo '</tr>'."\n"; |
| 998 |
echo '<tr>'."\n"; |
| 999 |
|
| 1000 |
echo '<td>'."\n"; |
| 1001 |
echo '<input type="text" autocomplete="off" name="ws_plugin__s2member_sp_ref_rev_notification_recipients" id="ws-plugin--s2member-sp-ref-rev-notification-recipients" value="'.format_to_edit($GLOBALS["WS_PLUGIN__"]["s2member"]["o"]["sp_ref_rev_notification_recipients"]).'" /><br />'."\n"; |
| 1002 |
echo 'This is a semicolon ( ; ) delimited list of Recipients. Here is an example:<br />'."\n"; |
| 1003 |
echo '<code>"John" <john@example.com>; admin@example.com; "Webmaster" <webmaster@example.com></code>'."\n"; |
| 1004 |
echo '</td>'."\n"; |
| 1005 |
|
| 1006 |
echo '</tr>'."\n"; |
| 1007 |
echo '</tbody>'."\n"; |
| 1008 |
echo '</table>'."\n"; |
| 1009 |
echo '</div>'."\n"; |
| 1010 |
|
| 1011 |
echo '</div>'."\n"; |
| 1012 |
|
| 1013 |
do_action("ws_plugin__s2member_during_api_ops_page_during_left_sections_after_sp_refund_reversal_notifications", get_defined_vars()); |
| 1014 |
} |
| 1015 |
|
| 1016 |
do_action("ws_plugin__s2member_during_api_ops_page_after_left_sections", get_defined_vars()); |
| 1017 |
|
| 1018 |
echo '<p class="submit"><input type="submit" value="Save All Changes" /></p>'."\n"; |
| 1019 |
|
| 1020 |
echo '</form>'."\n"; |
| 1021 |
|
| 1022 |
echo '</td>'."\n"; |
| 1023 |
|
| 1024 |
echo '<td class="ws-menu-page-table-r">'."\n"; |
| 1025 |
c_ws_plugin__s2member_menu_pages_rs::display(); |
| 1026 |
echo '</td>'."\n"; |
| 1027 |
|
| 1028 |
echo '</tr>'."\n"; |
| 1029 |
echo '</tbody>'."\n"; |
| 1030 |
echo '</table>'."\n"; |
| 1031 |
|
| 1032 |
echo '</div>'."\n"; |
| 1033 |
} |
| 1034 |
} |
| 1035 |
} |
| 1036 |
|
| 1037 |
new c_ws_plugin__s2member_menu_page_api_ops (); |
| 1038 |
|
