| Table of Contents |
|---|
Setup Checklist
...
1. POS TASKS
...
1. Set up Subscription Product Headers and Hotlists
| Status | ||||
|---|---|---|---|---|
|
Configure subscription product headers in RTP|One as simple products that contain a single access component.
Configure 'Cancel' and 'Freeze' hotlists in RTP|One and make note of the respective codes.
Configure subscription product headers with access.
2. Set up Validated Customer Procedure
| Status | ||||
|---|---|---|---|---|
|
Determine if stored procedures are required and contact Aspenware Represesntative for assistance in creating them.
...
| Status | ||||
|---|---|---|---|---|
|
...
2. INFRASTRUCTURE TASKS
...
Work with your Aspenware Representative to configure Subscription Processor Azure Function test and prod.
Status colour Red title Required
...
| Status | ||||
|---|---|---|---|---|
|
...
3. COMMERCE TASKS
...
1. Ensure that Subscriptions Plugin is Installed
| Status | ||||
|---|---|---|---|---|
|
2. Add the Is Subscription Classification
| Status | ||||
|---|---|---|---|---|
|
3. Create Dummy Product for Subscription Monthly Payment Product
| Status | ||||
|---|---|---|---|---|
|
4. Configure Subscription Types
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
Language String, Setting, HTML widget
| Status | ||||
|---|---|---|---|---|
|
Configure subscriptionsettings.subscriptionproductid during Commerce Prerequisite Tasks.
Configure Language Strings for Card Management in My Account using Strings below.
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
...
| Status | ||||
|---|---|---|---|---|
|
Prerequisite Tasks
...
POS Tasks
Work with your Aspenware Representative on this RTP|One Pre-work to make sure all necessary parts are configured.
1. Set up Subscription Product Headers and Hotlists
| Info |
|---|
NOTE: These products should be gated from being able to be sold onsite as guests MUST purchase subscription products on the Aspenware Commerce store. |
Configure subscription product headers in RTP|One as simple products that contain a single access component. Because these are ongoing charges that are triggered from the Aspenware Commerce subscription tool to Payeezy or Square, the only charge that will be reconciled to RTP|One is the first deposit charge paid when the order is first placed. Subsequent monthly charges are not sent back to RTP|One. Therefore, the product pricing setup in RTP|One is very simple.
Configure Freeze and Cancel hotlists in RTP|One and make note of the respective codes. When a charge fails, or when membership is frozen or canceled, subscription access is hotlisted with either the Cancel or Freeze hotlist, depending on the reason. Hotlists are also removed when subscription statuses go back to “active.”
Configure subscription product headers with one access component as hotlisting supports single access code use.
| Info |
|---|
NOTE: The cancel hotlist code will be set to RTP|One in the event that a subscription is canceled by an admin OR if the card on file fails a monthly payment. If clarification is needed as to whether the guest is still in the window where they can update their card and re-activate their access, check the Aspenware Admin tool to see if the Subscription status for the enrollment is failed-declined or canceled. If it is failed-declined, the guest can simply update their card in my account to remove the hotlist. |
2. (Optional) Set up Validated Customer Procedure
Commerce offers resorts the option to allow guests who are subscribers to be eligible to redeem free or steeply discounted products that they must redeem online, in advance, to “reserve” their spot. If your resort subscription is set up this way, work with your Aspenware representative to map a strategy of creating redemption products in both RTP|One and in Aspenware Commerce that “validate” only customers who have active subscription access (not hotlisted) are able to check out with these free “reservation products.” They will work with you to create a custom validated customer procedure that can be set up to work for online and in-person reservations. Aspenware can also add additional restrictions to this validation, examples we’ve set up in the past include, only allow a subscriber to reserve a single product type per day so that subscribers don’t over-consume inventory. They will also work with you on rules and guidelines for creating these validation product headers in RTP|One and Aspenware Commerce. Considerations include:
Validated Customer Procedure - Like validated prompt but allows restriction on assignment. These require custom SQL and Aspenware support.
Custom configuration can be added to the RTP|One stored procedure that prevents assigning the same person the same product type on the same day in subsequent orders.
If taking advantage of this rule, may need to add a rule to product headers.
Can be built in a way to use onsite
Redemption product header creation may be required (for onsite redemption, add the same validated customer procedure as used online.)
Infrastructure Tasks
Work with your Aspenware Representative to configure Subscription Processor Azure Function test and prod. The Subscription Processor Azure Function needs to connect to the Aspenware Commerce database and API, so it needs to be whitelisted/given permission to Nop. Aspenware will configure how often the subscription processor runs (req. every 30 seconds). Charges mostly happen at 12:01 am, however, the processor is set to run frequently. If someone updates their card in my account and they are in a declined status, it will charge them immediately, which will allow someone to fix their card on premise and use facilities immediately.
Commerce Tasks
1. Ensure that Subscriptions Plugin is Installed
Ensure that the Subscriptions plugin has been installed by your Aspenware Representative. Go to Configuration > Local Plugins search for the Subscriptions plugin. If plugin is not installed (matches image below), contact your Aspenware Service Representative.
2. Add the Is Subscription Classification
Add the Is Subscription classification if not already set up as a product classification. Check that the Is Subscription classification is not already set up before adding a new one.
Go to Aspenware Commerce > Product Classifications.
Select Add Classification in the upper right-hand corner.
Enter the following on the Classifications page:
Name : Is Subscription
Description: Assign this classification to Subscription Products Only
Is Subscription: Check
Leave all other checkboxes unchecked.
Click Add. THIS PAGE DOESN’T HAVE AN ADD BUTTON
3. Create Dummy Product for Subscription Monthly Payment Product
...
Go to Catalog > Products page in Admin.
...
Define the following values for this newly created add on product before saving the product:
Product name: This is the product that will be “sold” with each month’s charge and upon successful charge will be in the order table of the successful charge confirmation email. Suggested to name it something like “Subscription Monthly Payment.”
Short and Long description: Leave Blank.
Email description: Include anything that should be sent to customers in their monthly charge email. For example: “Your membership for this month has been successfully charged. Membership charges will occur every month on the same day of the month you originally purchased your membership. Tax is included in the price of the product.”
SKU (Product header): LEAVE BLANK
Categories: Make sure this is not added to a published category.
Published: Check this
Limited to stores: Leave blank
Available start/end dates: Leave blank
Price: Must be $0
Discounts: Leave blank
Tax Exempt: Check this. Subscription product CANNOT BE CONFIGURED WITH TAX.
DO NOT set up product attributes.
Click Save and Continue Edit.
...
Copy down the Product ID. This can be found in the URL of the product editor page. This ID will be used in the next step to define the subscription charge product in a setting.
...
...
Go to Configuration > Settings > All Settings and define the monthly payment charge product you just created as the value for the setting subscriptionsettings.subscriptionproductid
...
Setting
...
Value
...
subscriptionsettings.subscriptionproductid
...
ID of the subscription charge product (Taken from the page URL in the previous step.)
4. Configure Subscription Types
A subscription type is associated to a subscription product, defining the amount that should be charged for that subscription on a monthly basis and more. Other rules that are defined within a subscription type include retry days and RTP|One hotlist codes for freezes and cancels. If your resort offers varying levels of subscriptions or charges different subscription amounts based on age group, etc. multiple subscription types can be configured and mapped to different Subscription variants. To set up, edit or add Subscription Types, follow the steps below:
Go to Aspenware Commerce > Subscriptions and toggle to the Subscription Types page by clicking Subscription Types at the top of the page.
View already configured subscription types to determine if the one you need is already created.
If a new subscription type is needed, select CREATE NEW SUBSCRIPTION.
Enter the following properties:
Name: Name it descriptively enough to differentiate types from each other as each type likely charges different amounts. I.e. “Membership Ages 3-7”
Cancel Hotlist Code: Obatin from RTP|One and make sure these are configured in accordance with steps outlined about in POS Prerequisites section of this document. This hotlist code will be sent to RTP|One in the event of a failed payment or manual cancellation. This will likely be the same code across all membership types.
Freeze Hotlist Code: Obtain from RTP|One and make sure these are configured in accordance with steps outlined above in the POS Prerequisites section of this document. This hotlist code will be sent to RTP|One in the event of a manual freeze. Will likely be the same code across all membership types.
Retry Days: Enter the number of days that the membership payment should be “retried” in the event of a failed charged. Will likely be the same code across all membership types.
Amount: Enter the amount that should be charged each month to subscribers enrolled in this membership type. Will likely NOT be the same code across all membership types.
Click CREATE to save subscription type.
Make note of the ID that is assigned to the subscription type upon creation. This value will be used later when assigning subscription products to subscription types in the product classification admin.
| Note |
|---|
IMPORTANT: If changing the amount on a subscription type that has already been sold, a NEW Subscription Type MUST be configured. DO NOT update subscription types that have already been sold. If you need to make a change to pricing, simply unpublish the old subscription product, do not delete, and create a new subscription product and assign it to a new or existing subscription type. |
Settings, Language Strings and/or HTML Widgets for this Feature
...
Settings
Use this setting as described in Prerequisite Commerce Step 3.
...
Setting
...
Value
...
subscriptionsettings.subscriptionproductid
...
ID of the subscription charge product
Language Strings
Updating the content for the area of My Account where guests can manage and view their subscription credit card.
...
Go to Configuration > Languages page in Admin.
...
From the Edit Language details - English page, click the String Resources tab.
...
The following content is configurable through Language String resources.
...
Language String
...
Value
...
Location
...
account.subscriptions
...
Subscription Card Management
...
Within My Account, this is the Title for the page to manage cards associated with subscriptions.
...
account.subscriptions.description
...
{Description around updating cards and terms of memberships}
...
Within My Account, this is the description for the page to manage cards associated with subscriptions.
...
Account.Subscriptions.Selectmessage
...
Select subscriptions to update the payment credit card.
...
Within My Account, this is the message to help guests navigate selecting subscription products they would like to update.
...
Account.Subscriptions.NoSubscriptions
...
You have no subscription products.
...
Within My Account, thisis the message that shows if guest doesn’t have subscription products for themselves or anyone else in their household.
...
HTML Widgets
AW Commerce HTML Widgets that must first be completed
Detailed Setup Guide
Step 1 Header
1. Step 1 Header
...
| Table of Contents |
|---|
Setup Checklist
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
1. POS TASKS | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1. Set up Subscription Product Headers and Hotlists
2. Set up Validated Customer Procedure
|
| ||||||||||||||||||||||||||||||
2. INFRASTRUCTURE TASKS | |||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||
3. COMMERCE TASKS | |||||||||||||||||||||||||||||||
1. Ensure that Subscriptions Plugin is Installed
2. Add the Is Subscription Classification
3. Create Dummy Product for Subscription Monthly Payment Product
4. Configure Subscription Types
|
| ||||||||||||||||||||||||||||||
Language String, Setting, HTML widget
|
| ||||||||||||||||||||||||||||||
1. Configure Subscription Product
2. Assign Is Subscription Product Classification
3. Autofulfill Subscription Product
|
|
Prerequisite Tasks
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
POS Tasks
Work with your Aspenware Representative on this RTP|One Pre-work to make sure all necessary parts are configured.
1. Set up Subscription Product Headers and Hotlists
| Info |
|---|
NOTE: These products should be gated from being able to be sold onsite as guests MUST purchase subscription products on the Aspenware Commerce store. |
Configure subscription product headers in RTP|One as simple products that contain a single access component. Because these are ongoing charges that are triggered from the Aspenware Commerce subscription tool to Payeezy or Square, the only charge that will be reconciled to RTP|One is the first deposit charge paid when the order is first placed. Subsequent monthly charges are not sent back to RTP|One. Therefore, the product pricing setup in RTP|One is very simple.
Configure Freeze and Cancel hotlists in RTP|One and make note of the respective codes. When a charge fails, or when membership is frozen or canceled, subscription access is hotlisted with either the Cancel or Freeze hotlist, depending on the reason. Hotlists are also removed when subscription statuses go back to “active.”
Configure subscription product headers with one access component as hotlisting supports single access code use.
| Info |
|---|
NOTE: The cancel hotlist code will be set to RTP|One in the event that a subscription is canceled by an admin OR if the card on file fails a monthly payment. If clarification is needed as to whether the guest is still in the window where they can update their card and re-activate their access, check the Aspenware Admin tool to see if the Subscription status for the enrollment is failed-declined or canceled. If it is failed-declined, the guest can simply update their card in my account to remove the hotlist. |
2. (Optional) Set up Validated Customer Procedure
Commerce offers resorts the option to allow guests who are subscribers to be eligible to redeem free or steeply discounted products that they must redeem online, in advance, to “reserve” their spot. If your resort subscription is set up this way, work with your Aspenware representative to map a strategy of creating redemption products in both RTP|One and in Aspenware Commerce that “validate” only customers who have active subscription access (not hotlisted) are able to check out with these free “reservation products.” They will work with you to create a custom validated customer procedure that can be set up to work for online and in-person reservations. Aspenware can also add additional restrictions to this validation, examples we’ve set up in the past include, only allow a subscriber to reserve a single product type per day so that subscribers don’t over-consume inventory. They will also work with you on rules and guidelines for creating these validation product headers in RTP|One and Aspenware Commerce. Considerations include:
Validated Customer Procedure - Like validated prompt but allows restriction on assignment. These require custom SQL and Aspenware support.
Custom configuration can be added to the RTP|One stored procedure that prevents assigning the same person the same product type on the same day in subsequent orders.
If taking advantage of this rule, may need to add a rule to product headers.
Can be built in a way to use onsite
Redemption product header creation may be required (for onsite redemption, add the same validated customer procedure as used online.)
Infrastructure Tasks
Work with your Aspenware Representative to configure Subscription Processor Azure Function test and prod. The Subscription Processor Azure Function needs to connect to the Aspenware Commerce database and API, so it needs to be whitelisted/given permission to Nop. Aspenware will configure how often the subscription processor runs (req. every 30 seconds). Charges mostly happen at 12:01 am, however, the processor is set to run frequently. If someone updates their card in my account and they are in a declined status, it will charge them immediately, which will allow someone to fix their card on premise and use facilities immediately.
Commerce Tasks
1. Ensure that Subscriptions Plugin is Installed
Ensure that the Subscriptions plugin has been installed by your Aspenware Representative. Go to Configuration > Local Plugins search for the Subscriptions plugin. If plugin is not installed (matches image below), contact your Aspenware Service Representative.
2. Add the Is Subscription Classification
Add the Is Subscription classification if not already set up as a product classification. Check that the Is Subscription classification is not already set up before adding a new one.
Go to Aspenware Commerce > Product Classifications.
Select Add Classification in the upper right-hand corner.
Enter the following on the Classifications page:
Name : Is Subscription
Description: Assign this classification to Subscription Products Only
Is Subscription: Check
Leave all other checkboxes unchecked.
Click Add. THIS PAGE DOESN’T HAVE AN ADD BUTTON
3. Create Dummy Product for Subscription Monthly Payment Product
Go to Catalog > Products page in Admin.
ClickAdd new to create your new payment product.
Define the following values for this newly created add on product before saving the product:
Product name: This is the product that will be “sold” with each month’s charge and upon successful charge will be in the order table of the successful charge confirmation email. Suggested to name it something like “Subscription Monthly Payment.”
Short and Long description: Leave Blank.
Email description: Include anything that should be sent to customers in their monthly charge email. For example: “Your membership for this month has been successfully charged. Membership charges will occur every month on the same day of the month you originally purchased your membership. Tax is included in the price of the product.”
SKU (Product header): LEAVE BLANK
Categories: Make sure this is not added to a published category.
Published: Check this
Limited to stores: Leave blank
Available start/end dates: Leave blank
Price: Must be $0
Discounts: Leave blank
Tax Exempt: Check this. Subscription product CANNOT BE CONFIGURED WITH TAX.
DO NOT set up product attributes.
Click Save and Continue Edit.
Copy down the Product ID. This can be found in the URL of the product editor page. This ID will be used in the next step to define the subscription charge product in a setting.
Go to Configuration > Settings > All Settings and define the monthly payment charge product you just created as the value for the setting subscriptionsettings.subscriptionproductid
Setting | Value |
subscriptionsettings.subscriptionproductid | ID of the subscription charge product (Taken from the page URL in the previous step.) |
4. Configure Subscription Types
A subscription type is associated to a subscription product, defining the amount that should be charged for that subscription on a monthly basis and more. Other rules that are defined within a subscription type include retry days and RTP|One hotlist codes for freezes and cancels. If your resort offers varying levels of subscriptions or charges different subscription amounts based on age group, etc. multiple subscription types can be configured and mapped to different Subscription variants. To set up, edit or add Subscription Types, follow the steps below:
Go to Aspenware Commerce > Subscriptions and toggle to the Subscription Types page by clicking Subscription Types at the top of the page.
View already configured subscription types to determine if the one you need is already created.
If a new subscription type is needed, select CREATE NEW SUBSCRIPTION.
Enter the following properties:
Name: Name it descriptively enough to differentiate types from each other as each type likely charges different amounts. I.e. “Membership Ages 3-7”
Cancel Hotlist Code: Obatin from RTP|One and make sure these are configured in accordance with steps outlined about in POS Prerequisites section of this document. This hotlist code will be sent to RTP|One in the event of a failed payment or manual cancellation. This will likely be the same code across all membership types.
Freeze Hotlist Code: Obtain from RTP|One and make sure these are configured in accordance with steps outlined above in the POS Prerequisites section of this document. This hotlist code will be sent to RTP|One in the event of a manual freeze. Will likely be the same code across all membership types.
Retry Days: Enter the number of days that the membership payment should be “retried” in the event of a failed charged. Will likely be the same code across all membership types.
Amount: Enter the amount that should be charged each month to subscribers enrolled in this membership type. Will likely NOT be the same code across all membership types.
Click CREATE to save subscription type.
Make note of the ID that is assigned to the subscription type upon creation. This value will be used later when assigning subscription products to subscription types in the product classification admin.
| Note |
|---|
IMPORTANT: If changing the amount on a subscription type that has already been sold, a NEW Subscription Type MUST be configured. DO NOT update subscription types that have already been sold. If you need to make a change to pricing, simply unpublish the old subscription product, do not delete, and create a new subscription product and assign it to a new or existing subscription type. |
Settings, Language Strings and/or HTML Widgets for this Feature
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
Settings
Use this setting as described in Prerequisite Commerce Step 3.
Setting | Value |
subscriptionsettings.subscriptionproductid | ID of the subscription charge product |
Language Strings
Updating the content for the area of My Account where guests can manage and view their subscription credit card.
Go to Configuration > Languages page in Admin.
ClickEdit in the English row.
From the Edit Language details - English page, click the String Resources tab.
The following content is configurable through Language String resources.
Language String | Value | Location |
|---|---|---|
account.subscriptions | Subscription Card Management | Within My Account, this is the Title for the page to manage cards associated with subscriptions. |
account.subscriptions.description | {Description around updating cards and terms of memberships} | Within My Account, this is the description for the page to manage cards associated with subscriptions. |
Account.Subscriptions.Selectmessage | Select subscriptions to update the payment credit card. | Within My Account, this is the message to help guests navigate selecting subscription products they would like to update. |
Account.Subscriptions.NoSubscriptions | You have no subscription products. | Within My Account, thisis the message that shows if guest doesn’t have subscription products for themselves or anyone else in their household. |
...
HTML Widgets
AW Commerce HTML Widgets that must first be completed
Detailed Setup Guide
Configure Subscription Product
Assign Is Subscription Product Classification
Autofulfill Subscription Product
1. Configure Subscription Product
Subscription products are set up similarly to other products; however are often more simple than some ski products. These products should not have add-ons associated with them or overly complex attribute combination structures. Often they just have a single attribute like Age and a few age levels with different price points.
| Note |
|---|
IMPORTANT: If changing the price on a subscription product that has already been sold (either the deposit amount or the monthly charge amount), a NEW Aspenware Commerce product MUST be configured. DO NOT UPDATE pricing or subscription type assignments on Aspenware Commerce products that have already been sold. If you need to make a change to pricing, simply unpublish the old subscription product, do not delete it, and create a new subscription product following the steps below. |
| Note |
|---|
IMPORTANT: Do NOT delete Aspenware Commerce Subscription products that have already been sold. |
Go to Catalog > Products in Admin,
ClickAdd New to create a new product.
Follow standard product configuration steps outlined in Basic Product Configuration.
If the product being configured has variants, such as different ages. Follow standard attribute product configuration steps outlined in the Product Attribute Configuration section. However, the following difference exists for these products:
Subscription products should not be date-based products, so do not add a start date control type attribute.
Do not configure associated add-ons to be bundled with these products.
The price defined in the attribute combination table is the price of this product’s deposit amount (The amount charged each month on an ongoing basis will be configured in the Subscription plugin.)
| Info |
|---|
NOTE:The SKUS (RTP|One Product Header Codes) defined must be associated to RTP|One product headers that are set up correctly as subscription product header codes (as specified above.) |
2. Assign Is Subscription Product Classification
Subscription products require the ‘Is Subscription’ Product Classification is added.
Go to Aspenware Commerce > Product Classifications.
Select Add Assignment.
Find the desired Category and then Product from the drop-downs.
If the Subscription Type (amount charged per month) changes depending on the attribute value, check the specific attribute value (e.g. Adult) as well.
Select the ‘Assign’ checkbox next to the Is Subscription classification.
In the Value field, enter the ID of the associated Subscription Type Value (Ensure Subscription Types are first configured following the previous steps in this document.)
Scroll to the bottom and click Add.
| Info |
|---|
NOTE: The same subscription product variant (i.e. Adult Subscription) cannot be assigned more than one Subscription Type. However, a subscription type can have multiple products or product variants assigned to it. |
| Info |
|---|
NOTE: By adding this classification, a Square or Payeezy token is stored on order complete to ensure that future payments can be auto-charged. Also, for Square resorts, these subscriptions are automatically enrolled to be auto-charged the amount defined in the Subscription Type on the same day of each month going forward, starting next month. For more details on subscription charge details, see section Overview. |
3. Autofulfill Subscription Product
All Aspenware Subscription products also are required to be Autofulfilled.
Go to Aspenware Commerce > Autofulfill.
Find the desired product from the dropdown and select the Autofulfill checkbox. No need to check any of the attribute value checkboxes.
These subscription products also will likely need additional setup. Though nothing else is necessary to successfully set up the subscription functionality at this point, the following steps may need to be completed for your product:
Requires assignment *Required
Age rules
Waivers
Prevent duplicate assignment
Pass Media configuration
Renewal setup
Delivery
...