Clients on Stripe and with the SF Managed Package integration are not eligible for AutoRenew. If they request it be activated, please reach out to CS to coordinate on a response.TABLE OF CONTENTS |
Postman: Tenant Product Config Collection
The "Tenant Product Config" collection includes the following calls which you'll need to execute the actions below:
GET Tenant Product Config List
- This call allows you to check if AR is already configured for a client, and grab the ID for additional calls as needed.
POST Activate AR in Tenant
- This call actually enables AR in a tenant, and allows you to specify the billing cycle cadence (7 is the default) and the email cycle cadence (14 is the default). Unless explicitly directed by a CSM, do not change these defaults.
PUT Update Tenant AR Config
- This call allows you to update an existing AR configuration using the ID (use the above GET call to find the AR config ID), for example, if you want to update the billing cycle or email cycle cadences with a CSM's approval.
Enable AR Config and Seed Reports using Postman
1. Activate Auto Renew
- Get session for tenant in Sand10
- Run "POST Activate AR in Tenant" call
2. Seed Auto Renew Reports
- Click the three dots next to the "ACME Report Seeder - Membership Auto Renew (New)" folder and select “Run folder”
- All reports should automatically be selected, but de-select or select individual reports as needed (not common scenario)
- Select “Run ACME Report Seeder…”
3. Update Export Mapping for RE Clients
Once Auto Renew has been enabled for a tenant, you'll want to ensure that the Export mapping has been updated to include subscription fields for RE clients.
Before you get started, be sure to copy and paste the existing export mapping into a text file, and post it to the Slack channel for that client, so we have it to reference later.
Next, copy the standard export mapping with subscription fields here: https://peeksters.atlassian.net/wiki/spaces/PM/pages/17434574/Default+Export+Mappings and update export mapping for any environment for which you've enabled AR (typically Sand10 and Prod).
4. Update Theme variables
Confirm that their Theme includes the new variables and default language:
Text Variables
"orders-page-autorenew-required-cart-heading": "Auto Renew", "orders-page-autorenew-required-cart-message": "This membership will Auto Renew to save you time and lock in your benefits!", "orders-page-autorenew-cart-heading": "Auto Renew", "orders-page-autorenew-cart-message": "Save time and lock in your benefits with Membership Auto Renew!", "orders-page-autorenew-cart-checkbox-label": "Renew my membership automatically", "checkout-process-page-autorenew-message": "", "checkout-confirm-autorenew-message2": "Please call to make any changes your the Auto Renew membership.", "membership-profile-autorenew-renew-info": "Your membership will automatically renew within <b>billingCycleDay</b> days before it expires on <b>membershipExpirationDate</b>. Upon renewal, <b>currentMembershipOfferingRetailPrice</b> will be billed to <b>ccBrand ccLastFourDigits</b>.", "membership-profile-autorenew-active-message": "Please call to make any updates to your Auto Renew membership.", "membership-profile-autorenew-canceled-message": "You opted out of Membership Auto Renew on canceledDate. Please call us with any questions or to update your subscription.",
CSS Variables
Offering pop up box
"@membership-meta-autorenew-background-color": "#F4F4F4", "@membership-meta-autorenew-border": "1px solid #E4E4E4", "@membership-meta-autorenew-font-size": "100%", "@membership-meta-autorenew-text-color": "@page-color",
Optional Checkbox
"@checkbox-background": "#FFFFFF", "@checkbox-background-selected": "@btn-danger-bg", "@checkbox-border-color": "#9F9F9F", "@checkbox-check-mark-color": "#FFFFFF",
Theme Email variables
"email-confirmation-auto-renew-contact": "Please call to make changes to your Auto Renew membership.", "email-auto-renew-optout-intro-message-1": "Hello $primaryCardholderFirstName", "email-auto-renew-optout-intro-message-2": "Thank you for your order from $tenantName!", "email-auto-renew-optout-resubscribe": "If you would like to re-subscribe or have any questions, please contact us.", "email-auto-renew-reminder-salutation": "Hello $primaryCardholderFirstName", "email-auto-renew-reminder-default-message-1": "This is a reminder about the upcoming Auto Renew of your$membershipLevel membership. Your $ccBrand ending in $ccLastFour will be charged $formattedPrice on or before $expirationDateString.", "email-auto-renew-reminder-default-message-2": "You can call us at $tenantPhone to make changes to your Auto Renew membership or subscription.", "email-auto-renew-reminder-intro-message": "",
Client Documentation:
ACME eCommerce Text Variables - Auto Renew Memberships
Membership Auto Renew Email Variables
5. Repeat steps 1-4 for Prod
For Clients currently on Stripe
Follow the process above to enable AR in Sand10 only
In Settings > Admin, update the Payment processor settings to Express:
Express URL https://certtransaction.elementexpress.com Express Account ID 1056679 Express Account Token C9BDBBDE1FA0A47FCEB78D5F0E8C19C6E1E6E0B65CBBB572DCF8839878B162B182510C01 Express Application ID 8577 Express Acceptor ID 874767462
Update AR Config using Postman
- Get session for tenant in Sand10
- Use "GET Tenant Product Config List" to find the ID of the AR configuration
- Open "PUT Update Tenant AR Config"
- Add ID from step 2 and edit values in the Body as needed
- Send the call
- Repeat for Prod