Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 84 Current »

Set-up Checklist

This section is a comprehensive and high level summary of all tasks and prerequisites required for this feature to function properly. This section is purposed for use after an administrator is familiar with configuring this feature as an “audit” checklist. For detailed set-up instructions, jump down to “Prerequisite Tasks” and “Detailed Setup Guide” and then follow up with this checklist to ensure all steps are completed.

1. POS Tasks

RTP - The following setup must be completed for Payment Plans:

  • For the core product, Product Header configured with two components:

    • one access component that is positively priced at the price of the full product (including the down-payment amount) REQUIRED

    • one general component that is negatively priced at the amount of all future payments (does not include the down-payment amount). REQUIRED

  • If using multiple Pricing Seasons, ensure the pricing and dates exactly matches what is configured in Aspenware Commerce. OPTIONAL

  • If payment plan products are taxed exclusively, setup Product Headers for exclusive tax, ensuring it matches what is configured in Aspenware Commerce. OPTIONAL

  • A general product header created for future payment plan payments priced at $0REQUIRED

    • No rules should be assigned to this header

  • If an add-on is going to be setup as a payment plan, setup the add-on following the same rules as the core product OPTIONAL

PREREQUISITE

Siriusware - The following setup must be completed for Payment Plans:

  • Set up an ‘Invoice Account’ REQUIRED

  • Set up a new ‘Payment Type’ or select an existing one that will be used for payment plan invoices. REQUIRED

  • DCI configured and added to the Item Tree. REQUIRED

  • If payment plan products are taxed exclusively, setup Item(s) for Siriusware exclusive tax, ensuring it matches what is configured in Aspenware Commerce. OPTIONAL

PREREQUISITE

2. Infrastructure/General Tasks

Complete payment plan planning worksheet. REQUIRED

PREREQUISITE

Work with your Aspenware Representative to set Unity Setting 'AllowEntitlementPriceOverride' to TRUE. As part of this, ensure Identity-config.json, Swagger-config.json and the Azure appsettings.json files have the scope, "service.payment" REQUIRED

PREREQUISITE

Work with your Aspenware Representative to confirm that ‘AllowStorageofCC’ is set to TRUE in Aspenware Admin Settings. REQUIRED

PREREQUISITE

Aspenware DevOps needs to define the Payment Plan plugin as a plugin that needs styling, work with your Aspenware Representative on this. REQUIRED

PREREQUISITE

Work with your Aspenware Representative to set the value of the ‘paymentplanprocessor.url’ setting to the URL of the Payment Plan Processor. REQUIRED

PREREQUISITE

Work with your Aspenware Representative to install the payment plan plugin- REQUIRED

PREREQUISITE

If RTP|One is your POS, work with your Aspenware Representative to add the following SQL security privilege. ‘GRANT SELECT ON dbo.OrderMaster’ TO ‘awunityrole’. Also, might need to alter 'awuntiyrole' to 'rtponerole' depending on setup. REQUIRED

PREREQUISITE

If Siriusware is your POS, work with your Aspenware Representative to confirm that the ‘Invoice Account’ and ‘Payment Type’ names are added to Unity settings. REQUIRED

PREREQUISITE

3. Aspenware Commerce Tasks

Decide if payment plan products will be stand-alone or joint products REQUIRED

PREREQUISITE

The ‘Is Payment Plan’ Product Classification must be added as a Product Classification if not already set up. (do not create multiple Payment Plan classifications) REQUIRED

PREREQUISITE

If taxes on the deposit product are applied and the tax is configured to be exclusive, the 'Use Alternate Payment Plan Pricing' Product classification must be added as a classification if it is not already set up. OPTIONAL

PREREQUISITE

Update Payment Plan language strings if the default value is not desired. OPTIONAL

PREREQUISITE

Create/Update the required HTML widgets REQUIRED

  • Credit Card Payment Plan

PREREQUISITE

Update message templates to be sent on payment success/failure.

  • Update the 'OrderPlaced.CustomerNotification' Message Template which is sent on payment success and used as standard order confirm email. OPTIONAL

  • Update the ‘Customer.FailedPaymentPlanPayment' message template sent on payment failure. REQUIRED

PREREQUISITE

Add Payment Plan Reports via Sql Reports REQUIRED

  • ‘Payment Plan Payment Detail’

  • ‘Payment Plan Payment Summary’ 

  • 'Payment Plan Enrollment Detail' 

  • 'Payment Plan Enrollments - Brief' 

PREREQUISITE

Create a Simple $0 product to be charged for payment plan payments REQUIRED

PREREQUISITE

Create a core product for the payment plan product REQUIRED

  • Add required attributes (generate attribute combinations if applicable). REQUIRED

  • Enter the SKU and deposit price. REQUIRED

  • Ensure product is set to autofulfill REQUIRED

  • Add ‘Is Payment Plan’ Product Classification REQUIRED

  • Add ‘Use Alternate Payment Plan Pricing’ Product Classification if product is taxed exclusively OPTIONAL

  • Complete product setup, by adding requires assignment, age rules, waivers, etc. REQUIRED

PREREQUISITE / DETAILED SETUP

Create a product for payment plan add-on product OPTIONAL

  • Enter a SKU and depost Price for the add-on REQUIRED

  • Ensure product is set to autofulfill REQUIRED

PREREQUISITE /DETAILED SETUP

Create Pricing Schedule REQUIRED

DETAILED SETUP

Create Payment Schedule REQUIRED

DETAILED SETUP

Map products to pricing and payment schedules REQUIRED

DETAILED SETUP

Define payment plan product pricing REQUIRED

DETAILED SETUP

Run test payment plan orders through for every product and ensure POS booking and accounting REQUIRED

DETAILED SETUP

Test your payment plan.

SEE TEST GUIDE

HINT: Want to take it a step further? Check out our Payment Plan Training Webinar. Recording link here.

Prerequisite Tasks

This section describes all requirements that must be completed before you can begin setting up this feature. Once these tasks are complete continue to the next section.

1. POS Tasks

NOTE: Regular products and add-on products are both able to be configured as payment plan products and follow a payment plan schedule for charges using Aspenware Payment Plan functionality. These can still be set up as separate products in the POS and won’t need to be “bundled” into a single POS product.

  • For example, if a resort wanted to offer a payment plan on their all-access season passes, but also wanted to allow an upgrade add-on product, like a season-long parking pass, to be offered as a payment plan product, this is supported.

Products should be fully set up in the POS according to the following specs.

RTP

RTP|ONE product header set up requirements: Even if pay-in-full options of pass product headers are set up in RTP, there will need to be payment plan specific pass product headers set up for all products that will be offered as payment plans. These payment plan specific product headers must be set up according to the following instructions, which will be different from the standard pass product header setup in RTP | ONE. 

  • All payment plan product headers in RTP need the following two components at a minimum.

    • 1) The first component must be an access component that is a positively priced component. This component is priced at the price of the entire product (deposit + payment plan amount).

    • 2) The second component must be a general component that is a negatively priced component. This component is priced at the price of the payment plan amount (full amount - deposit amount). This component will be configured with the payment plan component GL accounting (liability account for payment plans).

IMPORTANT: The deposit amount is not defined on any component in RTP, but will be defined in the Aspenware Commerce product setup. The deposit amount should always equal the difference between the positively priced component and the negatively priced component. If this does not align, payment plans will not work and guests could be overcharged significantly. For example

  • If the First Component (positively priced pass component) is $1000

  • and the Second Component (negatively priced general component) is -$800

  • The deposit that is charged to the guest  upfront is $200, ($1000 - $800 = $200)

IMPORTANT: Tax is supported on these components, but the same tax should be on both the positive and negative prices components so that the effective tax rate is calculated on the net amount. For example, a 10% tax on the above $200 example would calculate $100 in tax on the access component, -$80 in tax on the negative payment plan component, and $20 in net (overall) tax.

Additionally, If taxes on the deposit are exclusive, you will need to add the Product Classification: “Use Alternate Payment Plan Pricing:” to support taxes. If they are inclusive you do not need to add this.

IMPORTANT: If using multiple pricing seasons, pricing seasons setup under the PHC in RTP and eventual pricing template in Aspenware Payment Plan Plugin must match exactly.

NOTE: If RTP|ONE is your POS, this payment plan product header cannot be sold over the phone or through a POS terminal because it must be sold online in Aspenware Commerce where the enrollments are housed and administered.

  • Create a ‘Payment Plan Payment’ Product Header in RTP|ONE

    • This product in RTP|ONE should be a simple and setup as a ‘General Product’ component profile type with ‘No Deferral’ and the accounting for the payment plan liability account in RTP. It will be credited upon successful payment. Also, do not add the ‘Customer Required’ Header Rule.

HINT: Upon successful payment plan payment, a transaction is created in RTP|ONE in order to reconcile to Aspenware Commerce and to credit the payment plan liability account that was debited in the initial sale. This transaction will sell the product header defined as the SKU on the Payment Plan Payment product defined in NopCommerce and will use the standard Aspenware Clearing payment method as payment. This transaction will be added to the original payment plan order and therefore is visible in RTP Order Processing under Transaction Viewer as well as other standard places a sales transaction can be viewed.

  • Optionally, if an add-on is going to be setup as a payment plan, setup the add-on following the same rules as the core product.

Siriusware

  • Set up an ‘Invoice Account’ that will house all of the invoices that will be created and sent to Siriusware via Aspenware Commerce. Aspenware recommends creating a new Invoice Account each season.

  • Set up a new ‘Payment Type’ or select an existing one that will be used for payment plan invoices that will be created and sent to Siriusware via Aspenware Commerce.

  • Sirisuware DCI set up requirements: Create your product DCI as you would typically configure it, adding to the item tree to enable sales in Aspenware Commerce. It is not necessary to set up a separate payment plan pass DCI and a pay-in-full pass DCI.

HINT: To use Aspenware’s Proprietary Payment Plan functionality, the product must be sold through Aspenware Commerce, but if you wish to sell payment plan passes over the phone or using POS terminals, this DCI should be configured using Siriusware’s native Payment Plan configuration. Aspenware Payment Plan sales of this product will bypass Siriusware’s native payment plan functionality, so this native Siriusware Payment plan functionality will only be leveraged for payment plan sales that are NOT transacted through Aspenware Commerce.

2. Infrastructure/General Tasks

  • Complete planning for payment plans. This is an example of how an Aspenware Payment Plan will function once fully setup in Aspenware Commerce.

    1. Pricing Schedule - In this example, two price schedules have been set up. This enables the price of the product to be increased over time and various payment schedules can also be set up within each pricing schedule.

    2. Total Charge - This value is not set up in Aspenware but is useful to visualize the total product revenue.

    3. Down Payment - This value is set up and tied to the PHC in Aspenware. Down payments (aka deposit amounts) cannot be set to automatically increase in Aspenware but can be manually updated if the change is timed to match an increase in RTP.

    4. PP Charges (Payment Plan Charges) - This value is input in the Payment Plan admin tool on the Product Assignment screen. Guests will be charged based on the date they purchased the product as defined in the Payment Schedule.

    5. Payment Schedule - These date ranges must cover all the dates defined in the Pricing Schedule and are used to determine the charge dates and charge %.

    6. Charge Dates - These are the dates the guest will be charged based on when they purchased the product defined in the Payment Schedule.

    7. Charge % - These are the percentages the guest will be charged based on when they purchased the product defined in the Payment Schedule.

    8. Charge Amount - This value is not set up in Aspenware, the charge amount is calculated by the values that are input in the PP Charge column and the Charge % column.

  • Work with your Aspenware Representative to add Unity Setting 'AllowEntitlementPriceOverride' is set to TRUE. This is required for payment plan payments to process. As part of this, ensure Identity-config.json and Swagger-config.json files have the scope, "service.payment"

  • Work with your Aspenware Representative to confirm that ‘AllowStorageofCC’ is set to TRUE in Aspenware Admin Settings.

  • Aspenware DevOps needs to define the Payment Plan plugin as a plugin that needs styling, work with your Aspenware Representative on this.

  • Work with your Aspenware Representative to set the value of the ‘paymentplanprocessor.url’ setting to the URL of the Payment Plan Processor.

  • Work with your Aspenware Representative to install the ‘Payment Plan’ plugin.

  • If RTP|One is your POS, work with your Aspenware Representative to add the following SQL security privilege. ‘GRANT SELECT ON dbo.OrderMaster’ TO ‘awunityrole’. Also, might need to alter 'awuntiyrole' to 'rtponerole' depending on setup.

  • If Siriusware is your POS, once ‘Invoice Account’ and ‘Payment Type’ are created, work with your Aspenware Representative to confirm that the ‘Invoice Account’ and ‘Payment Type’ names are added to Unity settings.

HINT: For Siriusware, when Aspenware Commerce completes payment plan payment, it creates an invoice against the defined ‘Invoice Account’, which includes the customer’s first name, last name, invoice name, and the amount (downpayment + all subsequent payment).  Each payment reduces the amount in the invoice. In the event of a completed payment plan, the invoice will be reduced to $0.

3. Commerce Tasks

  • Decide if you will be selling payment plan products as stand-alone Aspenware products or if they will be offered as a joint product with the “pay in full: option and “payment plan” option displayed as an attribute on a single pass product. Here are a list of benefits of either option

Standalone Product or Joint Product

Standalone Product

  • Unique email content sent on the deposit purchase.

  • Short and long descriptions are unique

  • Less complex admin configurations (particularly if using conditional attributes)

  • Fewer selections on the PDP

  • Product image can distinguish from pay-in-full with “Payment Plan” text

  • Able to link to a pay-in-full product in short/long description.

Joint Product

  • The email content is the same whether the guest is buying the payment plan or pay-in-full product.

  • Short and long descriptions are shared

  • Fewer products on the category page

  • Fewer products to manage in Admin

  • Single URL for brand site

Charge Product

  • Create a Simple Product in Aspenware Commerce with no product attributes. It should be priced at $0 and titled “Payment Plan Payment.”

    • For RTP|ONE: The SKU (PHC) should be the payment product header code that should be sold in the POS upon successful payment for each installment against the balance.

    • If the product is taxed in RTP, define a corresponding tax category on the “Payment Plan Payment” product in Aspenware Commerce.

    • For Siriusware: Leave the SKU (DCI) blank as this will not be sent back to the POS.

Configure Core Product (and Add-on product(s) if applicable)

  • Configure your core product, and if applicable, add-on product(s) that will be later set up as payment plan products. Start the product configuration process using the Core Product configuration guide here.

NOTE: Core products and add on products are both able to be configured as payment plan products and follow a payment plan schedule for charges using Aspenware Payment Plan functionality.

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

This feature may require updates to the following settings, language strings and/or HTML Widgets. Learn more about how to update and create Settings, Language Strings, and HTML widgets follow the links to the respective section.

Settings

  • The ‘Is Payment Plan’ Product Classification must be added as a classification if not already set up as a product classification.

    1. To set the ‘Is Payment Plan’ Product Classification up as a new classification go to Aspenware Commerce>Product Classifications and select Add Classification and define the following fields as follows

      1. Name: Is Aspenware Payment Plan

      2. Description: Assign this classification to core products that will leverage Aspenware Payment plan functionality. DO NOT assign to add-ons that will be payment plan products or products being setup with POS native Payment Plan functionality.

      3. Select the checkbox for Is Payment Plan.

      4. Click Add.

IMPORTANT: Check that the Is Payment Plan classification is not already set up before adding a new one, as you cannot have more than a single Is Payment Plan classification.

  • (Optional) If Tax is configured on the deposit product and tax is configured as exclusive, meaning it’s not included in the entered product price, you will need to add the Product Classification: 'Use Alternate Payment Plan Pricing:'

    1. To set the 'Use Alternate Payment Plan Pricing' Product Classification up as a new classification go to Aspenware Commerce>Product Classifications and select Add Classification and define the following fields as follows

      1. Name: Use Alternate Payment Plan Pricing

      2. Description: Assign this classification to payment plan products where tax on the payment plan deposit is exclusive - not included in the entered product price.

      3. Select the checkbox for Use Alternate Payment Plan Pricing.

      4. Click Add.

Language Strings

Instructions for updating language strings can be found here.

Resource Name

Default/Function

Example

shoppingcart.addtocart

Default: ADD TO CART

account.login.checkout.payment.paymentplanmessagetext

Function: Messaging in checkout when payment plan products in cart

Default: Payment methods are limited to credit card when your order contains a payment plan product. You must also choose a saved card or select to save the payment for future use.

account.paymentplans

Function: My Account - Payment Plans - Title of Payment Plan screen and left bar selection in My Account screens

Default: Payment Plans

image-20240501-150750.png

account.paymentplans.description

Function: My Account - Payment Plans - Top of the screen on the Payment Plan section of My Account Page

Default: The following orders were purchased with payment plans. These indicated credit cards will be automatically charged the amount shown on the payment date. You may update the credit cards as well as make the payment now rather than wait for the payment date.

image-20240501-151018.png

account.paymentplans.nopaymentplans

Function: My Account - Payment Plans

Default: You have no active payment plans.

paymentplans.multiproduct.buttontext

Function: My Account - Payment Plans

Default: View Payment Schedules

paymentplans.multiproduct.modal.duenow

Function: My Account - Payment Plans

Default: $${totalDepositDue} will be charged now.

paymentplans.multiproduct.modal.footergrandtotal

Function: My Account - Payment Plans

Default: Product total with deposit: $${productGrandTotal}

paymentplans.multiproduct.modal.headerbottommessage

Function: My Account - Payment Plans

paymentplans.multiproduct.modal.paymentscheduledisclaimer

Function: My Account - Payment Plans

Default: Payment plan payments will be charged to the credit card used in your original purchase. If necessary you can update these later in the My Account page.

paymentplans.multiproduct.modal.remainingtotal

Function: My Account - Payment Plans

Default: The remaining $${paymentsTotal} will be charged on the following schedule:

paymentplans.multiproduct.modal.title

Function: My Account - Payment Plans

Default: Payment Plan Schedules

paymentplans.singleproduct.buttontext

Function: My Account - Payment Plans

Default: View Payment Schedules

paymentplans.singleproduct.modal.depositpaid

Function: My Account - Payment Plans

Default: $${depositDue} was paid at time of purchase.

paymentplans.singleproduct.modal.duenow

Function: My Account - Payment Plans

Default: You will be charged a $${depositDue} deposit now followed by payments based on the schedule below:

paymentplans.singleproduct.modal.footergrandtotal

Function: My Account - Payment Plans

Default: Product total with deposit: $${productGrandTotal}

paymentplans.singleproduct.modal.headerbottommessage

Function: My Account - Payment Plans

Default: You will be billed on the following schedule:

paymentplans.singleproduct.modal.paymentscheduledisclaimer

Function: My Account - Payment Plans

Default: Payment plan payments will be charged to the credit card used in your original purchase.

paymentplans.singleproduct.modal.remainingtotal

Function: My Account - Payment Plans

paymentplans.singleproduct.modal.title

Function: My Account - Payment Plans

Default: Payment Plan Schedule

paymentplans.singleproduct.textabovebutton

Function: My Account - Payment Plans

Default: Your remaining balance will be billed in ${numberOfPayments} payments.

swpaymentplans.paymentschedulemessage

Function: My Account - Payment Plans - Only for Siriusware 

Default: Payment plan payments will be charged to the credit card used in your original purchase.

HTML Widgets

Instructions for updating HTML Widgets can be found HERE.

  • There are several content blocks that are displayed to the guest when purchasing payment plan products and managing payment plan credit cards. These are managed via HTML widgets and can be customized.

    • Title: Credit Card Payment Plan

      • widget zone: checkout_payment_method_bottom

Message Templates

Instructions for updating Message Templates can be found here.

  • Upon a successful charge, an order will be created in Aspenware Commerce in order to record the financial transaction. A standard order confirmation email will also be sent to the guest. This uses the same Message Template as all order confirmation emails. Given this, if the standard confirmation Message Template needs updating, update the 'OrderPlaced.CustomerNotification' template.

  • Upon a failed payment, the Payment Plan Processor will send a Failed Payment email to the guest to notify them of the problem. To update the HTML of this email, update the ‘Customer.FailedPaymentPlanPayment' message template.

    • If you are using standard Aspenware login, add in the following code to set your redirect URL to link to the Payment Plan page in My Account.

      <p><a href="https://SHOP.YOURRESORTDOMAIN.com/login?ReturnUrl=/customer/customerpaymentplans" target="_blank">Please Click Here </a><a>to change the credit card used for charging your payment and retry the payment.</a></strong></p>

    • If you are using Identity login, add in the following code to set your redirect URL to link to the Payment Plan page in My Account.

      <p><a href="https://SHOP.YOURRESORTDOMAIN.com/login?returnUrl=https://SHOP.YOURRESORTDOMAIN.com/customer/customerpaymentplans">Please Click Here </a><a> to change the credit card used for charging your payment and retry the payment.</a></p>

SQL Reports

Work with your Aspenware Representative to ensure that the following reports are installed and accessible from Nop4u > SQL Report Manager > Reports > Aspenware Payment Plans.

  • ‘Payment Plan Payment Detail’ - Fully detailed report on payments.  Grouped by payment.  Provides all available data on each payment. 

  • ‘Payment Plan Payment Summary’ - Summary report on payments. Grouped by payment.  Only shows key info like Product name, GL account, card type, payment date, and amount.  Only shows successful payments

  • 'Payment Plan Enrollment Detail' - Fully detailed report on payments but grouped by enrollment.

  • 'Payment Plan Enrollments -Brief' - Easy lookup for total amounts paid and any unpaid charges. Helps with inquiries and refunds.

  • ‘Payment Plan Payment Detail by Payment Date’ - Same as the "Payment Plan Enrollment Detail" report, except the report filters use successful payment dates instead of original purchase date.

Detailed Setup Guide

This section describes all required steps to set up the feature after prerequisite tasks have been completed.

  1. Configure Payment Plan Product

  2. Set Product to Autofulfill

  3. Assign Product Classification(s) to Core Product

  4. Complete Pass Product Setup

  5. (Optional) Configure Add on Payment Plan Products

  6. (Optional) Set Add-on Product to Autofulfill

  7. Configure Pricing Schedules

  8. Configure Payment Schedules

  9. Map Products to Pricing and Payment Schedules

  10. Define Payment Plan Product Balance Pricing

  11. Manage Payment Plan Enrollments

1. Configure Payment Plan Product

This task assumes that the prerequisite task of configuring the product shell for the Aspenware Payment Plan products has been configured according to this Configuration Guide.

IMPORTANT: If the payment plan product being configured has variants, such as different ages, levels of the pass, etc. Follow standard attribute product configuration steps outlined in the Product Attribute Configuration section. However, the following differences exist for these payment plan products:

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

  2. If RTP|ONE is your POS, don’t define discounts on these products. The price Aspenware Commerce sends to RTP |ONE must exactly match the product header configuration in the POS. See the prerequisite section above for details on product header configuration for these products.

  • These products require that at least one attribute value is defined on the product. It’s highly likely attribute combinations will be generated as well.

HINT:  Even if the product does not have variants, the product must be set up with attribute values. Use the dummy attribute setup detailed below to ensure proper setup IF the core product that you are setting up does not have variants. (Typically for renewal products and simple pass products). Only continue to follow the next steps if the payment plan product being setup DOES NOT have variants (i.e. Age Product Attribute). Italicized steps should be followed if the product is a Renewal Product. 

  1. Start by creating a new product attribute called Payment Plan 

    1. Add it under Catalog>Attributes>Product attributes.

    2. Assign this new product attribute a single default value called 'Is Payment Plan'

  2. Next, go to Configuration>Settings>All settings (advanced) and find the following setting: ‘catalogsettings.hiddenattributes’

    1. Add Payment Plan to the comma-separated list for the value of this setting

  3. Next, go to Catalog>Products, and edit the desired payment plan product, opening the Product Attributes section (could be collapsed). 

  4. Click Add new attribute and select ‘Is Payment Plan’ from the Attribute dropdown

    1. Add [Hidden] in Text prompt

    2. Check Is Required

    3. Set type to Radio button list

    4. Click Save and Continue Edit

    5. The Attribute Value ‘Is Payment Plan’ should be added by default, Edit it.

    6. Set Attribute value type to Simple

    7. Check that the Attribute Value is Preselected

    8. Leave the Name as Is Payment Plan

    9. Leave all other fields untouched

    10. Save the value

    11. Go back to Product Details

  5. Within the Product Attributes Section go to the Attribute Combinations Tab

    1. Click Generate several combinations

    2. From the modal, only check ‘Is Payment Plan’ and click generate

    3. Only one attribute combination row should have been generated.

    4. Edit it and add the Product header code and deposit price (see the note above on deposit price)

  • Go to Catalog > Products and choose to Edit the product.

  • From the product editor page go to Product Attributes > Attribute Combinations.

  • Select to Edit each payment plan variant row, and enter the product code in the SKU field, and the deposit price in the Overridden price field.

IMPORTANT: The deposit price is the full price of the product MINUS the payment plan amount, which will be paid over the course of a schedule. For example, consider a season pass that is $1000 total, where $100 is due at the time of purchase and $900 is to be paid overtime on a payment plan. In this case, $100 is the “deposit” while $900 is the “Payment Plan Balance”. 

HINT: You can have a single Aspenware Commerce product for full priced and payment plan passes, then use attributes to enable selecting pay-in-full vs payment plan variants.

  • For example, by selecting the “Pay $100 down” option, a guest enrolls in the payment plan. If they do not select that option, they pay full price upfront and are not enrolled.

  • Notice, the add-ons also follow the same lead as the payment plan selection: If selected the add-ons are payment plan, if not selected, the add-ons are full-priced.

  • Add-ons do not need to be offered as a payment plan if a payment plan enrollment is made for the core product, but it is an option.

HINT: If the entire Aspenware Commerce product is a payment plan product and attributes are NOT used on the pass product to select pay-in-full vs payment plan variants, consider using a title and hero image that differentiates the product as a payment plan product. See the example below.

  • Click Save.

2. Set Product to Autofulfill

  • Go to Aspenware Commerce > Autofulfill. 

  • Find the desired product from the dropdown and select the Autofulfill checkbox. Do not check any of the attribute value checkboxes.

  • Click Add.

IMPORTANT: Autofulfill setup needs to be completed for the core payment plan product AND add on payment plan products. 

3. Assign Product Classification(s) to Core Product

  • Finally, Go to Aspenware Commerce > Product Classifications > Add Assignment.

  • Select the Category and Product from the dropdowns and check to assign the Is Payment Plan product classification to payment plan core products or attribute values/combinations.

  • Click Add.

HINT:  If the purchase of the product, no matter the attributes the guest selects, is meant to enroll them in the payment plan, then add the classification to the product without selecting any attributes. The classification only needs to be added to the product a single time in this case.

However, if the selection of an attribute value is meant to enroll the guest in the payment plan, then add the classification after selecting that attribute value. For example, a product could have two options: “pay in full” or “pay $49 down now”. In this case, the classification would only be added to the “pay $49 down now” attribute value because paying in full should not enroll the guest in a payment plan.

NOTE: The Is Payment Plan classification serves several functions.

  • Forces a guest to enter a credit card on the payment step even if the deposit amount is $0. However, it is only an option to offer a $0 deposit on a payment plan product if your payment provider is Payeezy. Square and Braintree do not support forcing credit card collection with a $0 order balance.

  • Enables the HTML Widget ‘Credit Card Payment Plan’ to display on the payment step of checkout if the order contains a payment plan product. This widget is used to 1) message to the guest that they will be storing their card for later payments and b) can contain a link to payment plan terms and conditions if the resort doesn’t enforce that a guest checks a box to confirm that they have read and accepted terms and conditions for a payment plan.

    • If a resort requires that a guest checks a box to confirm that they have read and accepted payment plan terms, use Waiver configuration instead, which can be configured to only require checking a box to accept.

  • Disables pay with alternate RTP|ONE payments (vouchers, gift card, and stored value) ONLY if Braintree is the store’s payment provider.

IMPORTANT: Do not assign the ‘Is Payment Plan’ classification to add-on products, only core products should have this classification.

  • (Optional) If Tax is collected on the deposit product and tax is configured as exclusive in the store, meaning it’s not included in the entered product price, you will need to add the Product Classification: 'Use Alternate Payment Plan Pricing.' From Aspenware Commerce > Product Classifications > Add Assignment select the Category and Product from the dropdowns and check to assign the Use Alternate Payment Plan Pricing product classification to payment plan core products.

  • Click Add.

4. Complete Pass Product Setup

  • These payment plan products also will likely need additional setup, the following steps may need to be completed for your product.

    1. Requires assignment

    2. Age rules

    3. Waivers

    4. Prevent duplicate pass assignment

    5. Pass Media configuration

    6. Renewal setup

    7. Delivery

    8. Etc.

5. (Optional) Configure Add on Payment Plan Products

Add-On Products can contribute to the payment plan balance (i.e. the amount owed on the payment plan) and will be grouped together with the overall amount due and paid on the same schedule as the core product. 

NOTE: Continue reading below for requirements to set up your add-on. Then Step 9 below will explain how to distinguish if the add-on will be paid-in-full or paid as a payment-plan-payment.

This task assumes that the prerequisite task of configuring the add-on product for the Aspenware Payment Plan product has been configured according to the Configuration Guide.

  • Go to Catalog > Products > Edit for the desired payment plan add-on product.

  • Enter the product code in the SKU field in the product info area.

  • Enter the deposit price in the Price field in the Price area.

NOTE: The deposit price is the full price of the product MINUS the payment plan amount, which will be paid over the course of a schedule. For example, consider an add-on that is $1000 total, where $100 is due at the time of purchase and $900 is to be paid overtime on a payment plan. In this case, $100 is the “deposit” while $900 is the “Payment Plan Balance”. 

  • Click Save.

IMPORTANT: If offering guests the ability to pay for add-on products on the same schedule as they pay for the core season pass payment plan products, payment plan specific add-on products must be created in Aspenware Commerce.

Also, if your POS is RTP|ONE, the add-on product headers must also be set up as unique payment plan versions in the POS. See the prerequisite section above for details on product header configuration guidelines for these products.

IMPORTANT: Follow standard attribute product configuration steps outlined in the Add-on Configuration section. However, the following differences exist for these payment plan add-on products

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

  2. If RTP|ONE is your POS, don’t define discounts on these because the price Aspenware Commerce sends to RTP |ONE has to match the product header configuration.

  3. Price the add-on product at the deposit amount, which is is the full price of the product MINUS the payment plan amount, which will be paid over the course of a schedule. For example, consider a season-long parking pass that is $100 total, where $10 is due at the time of purchase and $90 is to be paid overtime on a payment plan. In this case, $10 is the “deposit” while $900 is the “Payment Plan Balance”.

  4. Linked add on (attributed add on) functionality is not supported on these products if the add on is part of the payment plan, so avoid setting the Is linked attribute setting when adding product attributes to these products.  

6. (Optional) Set Add-on Products to Autofulfill

  • Go to Aspenware Commerce > Autofulfill. 

  • Find the desired product from the dropdown and select the Autofulfill checkbox. Do not check any of the attribute value checkboxes.

  • Click Add.

NOTE: Do NOT add the ‘Is Payment Plan’ or ‘Use Alternate Payment Plan Pricing’ product classifications to add-on products.

7. Configure Pricing Schedules

Once the steps above are complete, you can now configure the details of the payment plan itself. The key terms on the Overview page will be helpful to understand when navigating the Payment Plan plugin.

  • Go to Aspenware Commerce > Payment Plans. 

NOTE: If you don’t see the Payment Plan option, work with your Aspenware Representative to have this installed on your store.

  • From the ellipses in the top right, select Pricing Schedule.

  • Click Add Pricing Schedules.

  • Define a Pricing Schedule Name. For example “Pass Sale 2021.”

  • Next, Click Add New Date Range.

  • A date range with Today’s Date will appear, select the date range to define the Pricing Schedule start and end date.

HINT: To easily use the calendar selector, navigate to your start date and click once, releasing the mouse. Then, navigate to your end date using the month arrows and click on your end date once, releasing the mouse. Do not drag and drop dates for the best user experience.

  • Repeat for all desired date ranges, which should map to your product pricing dates.

NOTE: This is a template that can be assigned to multiple payment plan products. Pricing Schedules define one or more date ranges that will later have pricing defined on them.

  • For example, consider the case that your $900 Payment Plan Balance (in the example above) will always be $900, no matter when the guest purchases the pass, and consider that the pass will be for sale from April 24 through Sept 30. In this case, you will need a Pricing Schedule configured with a start date on 4/24 and an end date of 09/30. 

  • Alternatively, if you know the payment plan balance will increase to $1000 on July 31, and again on $1100 on Aug 30, you will need 3 date ranges on your Pricing Schedule.

    4/24/2020 to 7/30/2020

    7/31/2020 to 8/29/2020

    8/30/2020 to 09/30/2020

HINT: Consider adding extra dates at the end of the range in case you extend the pricing deadline.

  • Click Apply Changes.

NOTE: Once saved, you can edit the schedule by clicking the name of the schedule or by selecting the Ellipses to the right of the schedule and choosing “Edit Schedule”.

8. Configure Payment Schedules

  • Go to Aspenware Commerce > Payment Plans. 

  • From the ellipses in the top right, select Payment Schedules.

  • Click Add Payment Schedule.

IMPORTANT: For versions 2.13.4 and earlier, Payment Schedules must be set up through the database and can be viewed and later edited through this plugin by selecting the Payment Schedule name. Work with your Aspenware Representative to configure your Payment Schedules.

  • Define a Payment Schedule Name.

  • Define your first Purchase Date range by selecting the dates listed next to Edit Date Date Range.

HINT: To easily use the calendar selector, navigate to your start date and click once, releasing the mouse. Then, navigate to your end date using the month arrows and click on your end date once, releasing the mouse. Do not drag and drop dates for the best user experience.

  • If offering more than a single payment to pay off the balance, click the + icon. This icon is under the Payment Date heading.

  • Enter the date of the first payment using the date picker and the Percent of the payment plan balance that will be charged on that date.

    • Repeat for all payment dates in the plan except the final payment date.

IMPORTANT: All payment dates should be configured to fall after the containing purchase date range.

HINT: All dates except the final payment date, need a % defined. The % can go to 4 decimal places, if needed, for example, 33.3333% for a ⅓ payment. 

  • The final payment will automatically be “balance due” which will calculate the amount remaining after the initial payments. The UI will display that percentage, but the functionality will really calculate the difference between the total of the first payments and the Payment Plan Balance to determine the amount owed on the final payment. 

    1. If there is only a single payment, it will only be Balance Due. 

  • The Final Payment (Balance Due) will automatically calculate the remainder Percent due based on prior payment dates, subtracting each payment date percentage from 100. Enter the date of the final payment using the date picker.

NOTE:  This is a template that can be assigned to multiple payment plan products. Payment Schedules define the payment dates based upon the purchase date. Payment dates are assigned to Purchase date ranges, meaning orders purchased within the purchase date range will adhere to the defined schedule. If payment dates will be different depending on when the payment plan is purchased, setup multiple purchase date ranges.

  • For example, consider that for payment plan enrollments with a purchase date of 4/29 to 7/30, you would like 10 equal payments on 8/1, 9/1, 10/1, 11/1, 12/1, 1/1, 2/1, 3/, 4/1, and 5/1. Then for purchase dates from 7/31 to 8/29, you would like 9 equal payments on 9/1, 10/1, 11/1, 12/1, 1/1, 2/1, 3/, 4/1, and 5/1. Then for purchase dates from 8/30 to 9/30, you would like 8 equal payments on 10/1, 11/1, 12/1, 1/1, 2/1, 3/, 4/1, and 5/1, you would configure 3 Purchase Date ranges:

    • 4/29 to 7/30,

    • 7/31 to 8/29,

    • and 8/30 to 9/30.

  • Click Apply Changes.

NOTE: Once saved, you can edit the schedule by clicking the name of the schedule or by selecting the Ellipses to the right of the schedule and choosing “Edit Schedule”.

9. Map Products to Pricing and Payment Schedules

  • Go to Aspenware Commerce > Payment Plans. 

  • From the ellipses in the top right, select Payment Schedules.

  • Click Product Assignments.

  • Click Add Assignment.

  • Choose a product from the Product Name dropdown.

HINT: The options in this list are displayed based on the assignment of the ‘Is Payment Plan' Product Classification to products or attributes in Product Classification admin. Only one Product Assignment configuration can be defined for each item in this list. Once configured, it can only be edited and will no longer show in the list when adding a new Product Assignment. Select the item you would like to configure.

  • After selecting the product name, select Price Attributes, which are the product attribute values added to the product that offers a payment plan option.

NOTE: Do not select values that do not contribute to the payment plan balance. For example, if a product offers an optional pass protection attribute for $20 but that entire $20 must be paid with the deposit at the time of purchase, do not check that attribute. However, if an add-on product does have a payment plan option, select it.

  • For example, if core pass products and premier upgrade add-on, and Woodward barn pass add-on products all have a payment plan option, but the pass protection add-on product does not have a payment plan option, check all that HAVE a payment plan option. See the example below.

  • Select the Payment Schedule template you would like to apply to this Product Assignment.

  • Select the Pricing Schedule template you would like to apply to this Product Assignment.

  • The Failed Payment Hotlist Code is used for RTP|ONE Resorts. Enter the Access Hotlist code that will be used when hotlisting payment plan prepaid access.

  • Enter the number of retry days in Failed Payment Retry Days.  

NOTE: Minimum value of 1 must be entered as Retry Days are the number of days you would like to attempt to charge the guest. For example, if set to 5 days, on the initial charge date the guest will be charged, if that charge fails the system will attempt a successful charge once a day for the next 4 days until the charge succeeds or 4 retries have occurred.

  • Enter the Product ID of the Aspenware Commerce “Payment Plan Payment” product in the Payment Product ID field.

HINT: To find the Aspenware Commerce Payment Product ID, navigate to the VERY simple product from Catalog >Products that was created as part of the prerequisite tasks. Edit the product, and from the product editor page, you will find the id within the URL (see image below).

This is the product that will be “sold” upon each successful payment plan payment. This product should have been configured during the prerequisite Commerce tasks and prerequisite POS tasks if using RTP|ONE.

  • Click Apply Changes.

NOTE: Once saved, you can edit the schedule by clicking the name of the schedule or by selecting the Ellipses to the right of the schedule and choosing “Edit Assignment”.

Later changes do not affect Payment Plan Enrollments that are already created. Only yet-to-be-sold enrollments will be affected.

10. Define Payment Plan Product Balance Pricing

  • Go to Aspenware Commerce > Payment Plans. 

  • From the ellipses in the top right, select Payment Schedules.

  • Click Product Assignments.

  • Click on the Ellipses to the right of the schedule and click Attribute Pricing.

  • Select a ‘Pricing Season’ from the Assigned Pricing Seasons.

  • In the Price field, enter the Payment Plan Balance for each payment plan product.

NOTE: The Payment Plan Balance is the total amount owed on the payment plan, not including the initial deposit. It is calculated based on the attribute value selections that a guest makes on the PDP during the purchase of the product.

  • For example, consider a season pass that is $1000 total, where $100 is due at the time of purchase and $900 is to be paid overtime on a payment plan. In this case, $100 is the “deposit” while $900 is the “Payment Plan Balance”. 

IMPORTANT: For Aspenware Payment Plans, the deposit and balance can be taxed.

  • If tax must be charged on the payment plan balance and is exclusive, do not include tax in the prices entered here.

  • However, if the balance is inclusive of tax, the prices entered here can include tax. For example, if a 10% tax needs to be charged on each payment, simply price the payment plan balance to be $990, rather than $900.

HINT: If add-ons are being offered as payment plan products, the price of the add-on defined here should be the price of the add-on product’s payment plan balance only, NOT the price of the core product PLUS the add-on product.

  • Repeat for all pricing schedules.

  • Click Apply Changes.

NOTE: Once saved, you can edit the schedule by clicking the name of the schedule or by selecting the Ellipses to the right of the schedule and choosing “Attribute Pricing”.

Later changes do not affect Payment Plan Enrollments that are already created. Only yet-to-be-sold enrollments will be affected.

11. Manage Payment Plan Enrollments

When a guest purchases a payment plan product and upon a successful order, the Payment Plan Enrollment and Payment Plan Scheduled Payments are immediately created and are visible in My Account for the guest, so they can view their payment plan schedule and manage their credit card, and within Aspenware Commerce administration resort admins can manage payment plan enrollments.

  • Go to Aspenware Commerce > Payment Plans. This page automatically loads to the Payment Plan Enrollments page which lists all payment plan enrollments, no matter their status.

NOTE: The enrollments table displays the following information about each payment plan enrollment.

  • ID - The Enrollment ID - the unique identifier of the payment plan enrollment. 

  • Enrollment Date - The day the guest purchased the payment plan.

  • Order ID - The original Aspenware Commerce Order ID from the original purchase. 

  • Customer Name - The name of the customer assigned to the payment plan.

  • Customer Email - The email of the purchaser. This only shows if the assigned customer is the purchaser. 

  • Product - The Aspenware Commerce product originally purchased by the guest. 

  • Next Payment  - The next payment date, if applicable. 

  • Amount - The amount of the next payment, if applicable. 

  • Has Failed Payment - If true, one or more payments under the enrollment if “Failed”. If false, no payments are Failed.

  • To find a specific enrollment, use the following search criteria.

    • Enrollment Dates - A range of enrollment dates can be used to filter. The start and end date must be selected to define the range. If a single day is being filtered, it must be clicked twice to select it. 

    • Order ID - The original AW Commerce order ID, less the prefix. 

    • Customer Name - any portion of the customer name or email an be entered here .For example, if the email is “sally@gmailemail.com”, simply entering “sally@gmail” will filter down to just enrollments with that email associated. 

    • Payment Dates - A range of next payment dates can be used to filter. The start and end date must be selected to define the range. If a single day is being filtered, it must be clicked twice to select it. 

    • Has Failed Payments - If toggled to True, only enrollments with Has Failed Payment = True will be returned.

  • Once the specific enrollment is found, use the ellipses at the right of the enrollment row to take one of the following actions on the enrollment.

    • Set to Open - this updates the enrollment status to Open. If the access was hotlisted in RTP with the Failed Payment Hotlist Code, the hotlist will be removed. If the access was hotlisted with another hotlist code, the hotlist will not be removed. 

    • Set to Cancelled - this updates the enrollment status to Cancelled. This will add the Failed Payment Hotlist Code to the access in RTP as long as the access was not already hotlisted with another hotlist code. This will also stop any payments under this enrollment from processing. 

    • Set to Paid in Full - This will mark the enrollment status to Paid in Full and will prevent any open payments from processing. This does not have any hotlisting functionality in RTP.

    • Set to Pending - This Indicates the enrollment process did not fully complete. Most often this is due to the "hotlist until paid" checkbox being checked on the product. Currently, the checkbox is not supported. If payment plan orders are in this state you may need to reach out to support@aspenware.com for assistance to update these orders.

    • Set to Reprocess Failed Payments - This sets all failed payments within the enrollment to Retry Days to 0 and sets the payment status for all these failed payments to open. Previously, the only way to mark a failed payment on behalf of a guest was to update the records in the database tables directly. Now, resort admins can simply select Reprocess Failed Payments in the Payment Plan Enrollments form in Administration as shown below. The Payment Plan process will then pick up these records each day.

    • Set to Reprocess POS Records - Select this when you don't want to charge the customer but want to send to RTP. This could be the case if the charge was successful, but the creation of the order in RTP for the payment was not, so you just want to send to RTP, but not charge the card. In contrast to reprocess failed payments, which does it all.

       

NOTE: Payment plan payments have the following statuses: 

  • Open: Open payments that have not been processed yet. 

  • Paid: A payment that has been successfully paid. 

  • Failed: A payment that has been attempted to be charged but has failed in the card processor.

12. Test Payment Plan

Aspenware highly recommends thoroughly testing you payment plan products. Please see the Payment Plan Test Guide for suggestions.

  • No labels