Payment Plan Field List

Below is a list of fields that are used to configure your payment plans. If you are unsure as to how to best configure any of these fields, you may find more information on how to setup a payment plan, or you may open a ticket for assistance. Once your payment plan is configured, you may then configure one or more of your Product Options to use the payment plan. Additionally, once a customer orders a product option configured with the payment plan, a unique payment plan instance is created (using the payment plan settings specified in the fields described below) to control recurring payments for that specific order.

Fields

Name
The name of the payment plan.
Description
A text description of the payment plan.
Recurrence Type
There are currently 2 options here as follows:
  • Scheduled - The payment plan bills the customer on a set schedule determined by the Frequency, Frequency Interval, and Days Until Start fields below it.
  • Day Of Month -The payment plan bills the customer on the specified day of each month defined by the Day Of Month field below it.
Frequency
Only available for Scheduled Recurrence Type. The number of Days, Weeks, Months, or Years (specified by Frequency Interval) between billing attempts. NOTE:If you are using the PayPal Payments Pro gateway for credit processing and are not storing full credit card details, PayPal will invalidate the reference transaction after one year. In this scenario, it is suggested to configure a yearly plan to use an interval a few days short of one year to allow for any retry attempts.
Frequency Interval
Only available for Scheduled Recurrence Type. The interval (Days, Weeks, Months, or Years) to use with the Frequency.
Days Until Start
Only available for Scheduled Recurrence Type. The number of days after the initial purchase to set as the first billing date. IMPORTANT: If this value is set to zero, then the first recurring payment is processed the next time the payment processor runs. Since the first payment is accepted through the cart, the value for this field should be consistent with the payment frequency.
Day Of Month
Only available for Day of Month Recurrence Type. This is the day of the month the customer will be billed on. During initial purchase, the first billing date will be set to the next occurrence of this day of month.
Number of Payments
The number of times the customer will be billed. If this is set to -1, the customer will be continually billed at the given schedule, with no stopping point until they or an administrator disables the payment plan.
Installment Price
The price the customer will be charged at each billing.
Installment Surcharge
An optional surcharge to be added to each installment, on top of the Installment Price.
Installment Product Option
The product option to be placed on the installment invoice. A new product and product option will likely need to be created for this. Note that the price defined for the installment product option will be ignored when processing, and the payment plan Installment Price will be used instead.
Email Customer On Installment
If checked, the customer will be emailed an invoice after each installment is charged to them.
Number of Retries
If an installment payment attempt is declined, it can retry the charge once per day up to the number of retries configured. It will trigger the Declined Action if the final attempt is declined, or it will continue the payment plan if any retry is successful.
Declined Action
The action to take if the Number of Retries is exceeded for a customer when processing installments. Currently, there are two options:
  • Notify Admin - An email notification will be sent to an administrator.
  • Disable License - Any licenses associated with the payment plan will be disabled and an email notification will be sent to an administrator. The following changes are made to the License ID:
    • Status is set to Check (CHK), which will deactivate the software when it next validates with SOLO Server.
    • Notes is updated to "This license has been disabled due to a failed final payment plan payment attempt."
    • Modified Date is updated.
    • Modified By is updated to Nightly Run.
Persist Discount Information
If checked, and priority code discount information used for the initial order will be persisted to the payment plan instance. As long as the priority code remains valid, the discount will be reapplied for each recurring billing cycle. Note that this only applies to product option level priority codes - author level priority codes are not persisted.
Increment License Expiration:
If checked, upon each successful payment, the expiration date of the original license will be incremented by the value of License Expiration Increment Days.
License Expiration Increment Days
Available only if Increment License Expiration is set. The number of days the expiration date of the original license will be incremented after a successful payment plan payment. An example for this text is as follows:
Purchase Text
This will be displayed on the line item level of the cart as well as on both the initial purchase and installment invoices. It accepts HTML, and an example for this text is as follows:
Purchase License Text
This will be displayed on the line item level above the Purchase Text on the cart and initial purchase invoice. It accepts HTML, and an example for this text is as follows:
  • This purchase will initiate automatic annual subscription billing for the use of this product. You will be automatically billed US$XXXX per License ID every 365 days for your use of the product. Your purchase receipts will include instructions about how to cancel your subscription when you wish to do so. For any billing inquiries, please contact billing@yourcompany.com.
Installment Text
This will be displayed on the line item level above the Purchase Text on installment invoices. It accepts HTML, and an example for this text is as follows:
  • Your product subscription has been extended by 365 days.