Skip to main content

Package Purchases Add-on

Written by Teachworks Support

The Package Purchases Add-on allows your clients to purchase packages themselves from a link that can be included in the Low Package Balance Alert email.

Enabling the Add-on

  1. Click on "Account" and then click on "Integrations & Add-ons".

  2. Use the search field at the top and enter "Package Purchases".

  3. Switch the toggle to "On" to enable the add-on.

Settings

Click on “Settings” to configure the add-on. On the settings page, you can customize the following:

  1. Link Text: The text entered in this field will be used for the package purchase link that you'll add in your Package Balance Alert email template. The default text is: "Purchase Package".

  2. Minimum Package Size: This setting allow you to specify a minimum quantity that will be used if the package quantity entered by the client is lower than the quantity of the client's last package.

  3. Pricing Method: This field allows you to set the price of the new package using either the billing settings on the student's profile or the price from their last package.

  4. Surcharge: This allows you to add a surcharge to the package invoice. This will only be displayed if you are using the Invoice Surcharge Add-on.

  5. Tax Method: Specify the tax method to be used and you can select between "Fixed" and "Last Package", which will use the tax method from the last package invoice.

  6. Tax Treatment: You can select the tax treatment for the invoice and the options are "Tax Exempt", "Tax Exclusive", or "Tax Inclusive".

  7. Sales Tax Rate: Specify the sales tax rate for the package invoice.

  8. Success Message: This field allows you to enter a message that will be displayed when a package purchase has been successful.

  9. Failed Message: This field allows you to enter a message that will be displayed if the client's payment has failed. You can include instructions for contacting your company to complete the purchase.

  10. Email Payment Receipt to Client: Enable this setting if you would like to email a payment receipt to the client after purchasing a package.

  11. Email Notification to Company: Enable this setting to email your company's email address after a client purchases a package.

Usage

In order for your clients to purchase a new package through the Low Balance Alert Notification, you'll need to ensure you add the {PURCHASE-LINK} merge tag to the Package Balance Alerts email template.

Below is an example of how the process looks like when a client purchases a package through the Low Balance Alert Notification:

  1. Click on the "Buy Package" link in the Low Package Balance Notification.
    ​

  2. Enter your credit card details.
    ​

  3. Click on the "Buy Package" button to complete the process.

NOTE: The "Buy Package" link text will be set to what you have entered in the "Link Text" field in the Package Purchases Add-on's settings page.

Possible Error Messages

When using the Purchase Packages Add-on, your client may be directed to a webpage with an error. You can find a description of each error and what causes them below:

  1. This package service is no longer available - This error means that the service used for their previous package is no longer active.

  2. Package purchase is not enabled or is unavailable for this package - This error means that either one of the following has occurred: the Package Purchases Add-on is disabled, The Stripe Add-on is disabled, or the package invoice has a cost that is less than 50 cents (so it can't be processed by Stripe).

  3. The URL is invalid or the package may have been deleted - This error means that the URL is invalid or the previous package has been deleted.

Did this answer your question?