Versions Compared

Key

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

...

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

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

    Status
    colourRed
    titleRequired

Status
colourYellow
titlePrerequisite

3. COMMERCE TASKS

1. Ensure that Subscriptions Plugin is Installed

Status
colourRed
titlerequired

2. Add the Is Subscription Classification

Status
colourRed
titlerequired

3. Create Dummy Product for Subscription Monthly Payment Product

Status
colourRed
titlerequired

4. Configure Subscription Types

Status
colourRed
titlerequired

Status
colourYellow
titlePrerequisite

Language String, Setting, HTML widget , etc. Task 4 -

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
Configuration Task 5 -

Status
colourRed
titleRequired

Status
colourGreen
titleDetailed Setup

...

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

    Image RemovedImage Added

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: 

    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.

    Image RemovedImage Added

  • Go to Configuration > Settings > All Settings and define the monthly payment charge product you just created as the value for the setting subscriptionsettings.subscriptionproductid

...

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.

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

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

    Image Added
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

...

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. 

...