Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Setup Checklist

...

Table of Contents

Setup Checklist

Insert excerpt
Set-up Checklist
Set-up Checklist
nopaneltrue

1. POS Tasks

1. Set up Subscription Product Headers and Hotlists

Status
colourRed
titleRequired

  • 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
colourBlue
titleoptional

  • Determine if stored procedures are required and contact Aspenware Represesntative for assistance in creating them.

Status
colourYellow
titlePrerequisite

2.

INFRASTRUCTURE TASKS

Infrastructure Tasks

  • Work with your Aspenware Representative to configure Subscription Processor Azure Function test and prod.

    Status
    colourRed
    titleRequired

Status
colourYellow
titlePrerequisite

3.

COMMERCE TASKS

Commerce Tasks

1. Ensure that Subscriptions Plugin is Installed

Status
colourRed
titlerequired

Go to Configuration > Local Plugins search for the Subscriptions plugin. If plugin is not installed (matches image below), contact your Aspenware Service Representative.

titlerequired
 

2. Add the Is Subscription Classification

Status
colourRed
titlerequired

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.

3. Create Dummy Product for Subscription Monthly Payment Product

Status
colourRed
titlerequired

Go to Catalog > Products page in Admin to create your new product.

colourRed
titlerequired

  • 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.

4. Configure Subscription Types

Status
colourRed
titlerequired

  • 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.

  • Make note of the ID that is new Subscription Type IDs that are 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.

Status
colourYellow
titlePrerequisite

Language String, Setting, HTML widget

Status
colourBlue
titleoptional

  • Configure subscriptionsettings.subscriptionproductid during Commerce Prerequisite Tasks.

  • Configure Language Strings for Card Management in My Account using Strings below.

Status
colourYellow
titlePrerequisite

1. Configure Subscription Product

Status
colourRed
titleRequired

  • Go to Catalog > Products in Admin,

  • Add New product. 

    Required

    2. Assign Is Subscription Product Classification

    Status
    colourRed
    titlerequired

  • 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.

    Red
    titlerequired

    • 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.)

    3. Autofulfill Subscription Product

    Status
    colourRed
    titlerequired

    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.

  • 4. Locate and Filter Subscription Enrollments

    Status
    colourBlue
    titleoptional

  • Go to Aspenware Commerce > Subscriptions and toggle to the Subscription Enrollments page.

  • Use the search and filter criteria to narrow down the list of subscriptions.

    and Filter Subscription Enrollments

    Status
    colourBlue
    titleoptional

    5. Update Status and Subscription Type of Subscription Enrollments

    Status
    colourBlue
    titleoptional

    Update next payment date, enrollment

    Status

    or subscription type in the field next to the corresponding button.

    Status
    colourGreen
    titleDetailed Setup

    Prerequisite Tasks

    Insert excerpt
    AE:Prerequisites Tasks ExcerptAE:
    Prerequisites Tasks Excerpt
    nopaneltrue

    ...

    • Configure subscription product headers in RTP|One as simple products that contain a single access component.

    Note

    IMPORTANT: 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.

    ...

    • 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. 

    ...

    • 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, which will appear after all the required items are complete (above).

    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: 

      1. 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.”

      2. Short and Long description: Leave Blank.

      3. 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.”

      4. SKU (Product header): LEAVE BLANK

      5. Categories: Make sure this is not added to a published category. 

      6. Published: Check this

      7. Limited to stores: Leave blank

      8. Available start/end dates: Leave blank

      9. Price: Must be $0

      10. Discounts: Leave blank

      11. Tax Exempt: Check this. Subscription product CANNOT BE CONFIGURED WITH TAX.

      12. DO NOT set up product attributes. 

      13. 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

    ...

    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.

    ...

    Settings, Language Strings and/or HTML Widgets for this Feature

    Insert excerpt
    AE:Setting, Language String and/or HTML Widgets for this featureAE:
    Setting, Language String and/or HTML Widgets for this feature
    nopaneltrue

    ...

    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. 

    ...

    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. 

      1. 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:

      1. Subscription products should not be date-based products, so do not add a start date control type attribute. 

      2. Do not configure associated add-ons to be bundled with these products. 

      3. 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.)

    ...

    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. 

    ...

    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:

      1. Requires assignment *Required

      2. Age rules

      3. Waivers

      4. Prevent duplicate assignment

      5. Pass Media configuration

      6. Renewal setup

      7. Delivery

    ...

    Within the Subscriptions Admin, administrators can research and act on guest subscription orders to cancel, freeze and change subscription amounts. 

    • Go to Aspenware Commerce > Subscriptions and toggle to the Subscription Enrollments page.

    • Use the following search and filter criteria to narrow down the list of subscriptions: 

      1. Enrollment Date Range: Date range during which the initial subscription purchase took place. 

      2. Next Payment Date Range: Date range during which the next subscription monthly charge will take place. 

      3. Status: Status of Enrollment. 

        1. Active: Subscription that is charged monthly and not hotlisted

        2. Failed Payment Declined: Subscription that failed the last payment attempt but is still within the retry days limit and has not yet been canceled. Is hotlisted in RTP|One, but if a charge succeeds, hotlist will be auto-removed. 

        3. Frozen: Usually set by an admin in the event of injury. Treated like a cancellation, but has a freeze hotlist reason sent to RTP instead of a cancel hotlist. Must be manually set back to active to be “unfrozen.”

        4. Cancelled: Membership is no longer attempting to charge on a regular basis and has been hotlisted in RTP. Can get to this state by an admin canceling the membership or by a guest failing their payment and not being corrected within the retry days period.

      4. First Name

      5. Last Name

      6. Email Address

      7. ID: Subscription Enrollment ID

    ...

    • To change the next payment date, enter the new date in the field above the UPDATE NEXT PAYMENT DATE button, select the desired subscription. 

    • Click UPDATE NEXT PAYMENT DATE.

    UPDATE ENROLLMENT STATUS

    • To change the status, click in the field above the UPDATE ENROLLMENT STATUS button and select the desired status.  Choose one of the statuses below:

      1. Active: Subscription that is charged monthly and not hotlisted. Reactivate a frozen or canceled membership.

      2. Cancelled: Membership will no longer attempt to charge on a regular basis and will be hotlisted in RTP|One

      3. Frozen: Usually set by an admin in the event of injury. Acts like a cancellation, but has a freeze hotlist reason sent to RTP|One instead of a cancel hotlist. Must be manually set back to active to be “unfrozen.”

    • Click UPDATE ENROLLMENT STATUS.

    Info

    NOTE:There is no subscription status update date, so if a business rule enforces that freezes can only last so long, record freeze requests and dates in a separate list until the subscription freeze report can be built in Nop4U reports. 

    ...

    • To change the subscription type, click click in the field above the UPDATE SUBSCRIPTION TYPE button, select the desired subscription. 

      1. By changing the subscription type on a membership enrollment, the amount charged on the next payment date will be updated to the amount defined on the new subscription type. 

      2. If you don’t see the desired subscription type, can create a new one by following the steps in the Configure Subscription Type section above. 

    • Click UPDATE SUBSCRIPTION TYPE.

    Info

    NOTE: A common scenario where an admin will change the subscription type is due to a guest aging out of one group to the next. To find guests who are in the wrong “aged subscription” consult the aging report in Nop4U SQL Reports. 

    ...