Plans

This topic describes the following pages:

The Plans page displays a list of payment plans associated with your customers’ subscriptions. On this page, you can add a new plan or access more information about a specific plan.

Note
A Plan is the amount and frequency that a customer will be charged. Subscriptions assign customers to the Plan.
First, create a Plan. Then, you can add Subscriptions to the Plan. For more information on subscriptions, open the Recurring Payments and Subscription Details pages.

To access the Plans page:

Click the PLUS icon next to Recurring Payments under Payments in the left navigation panel to open the Recurring Payments dropdown.
Click Plans in the dropdown menu.

Plans Features

Click here to view the features of the Plans page.

Plans Information Banner

The Plans Information banner displays an overview of the plans and subscriptions under your account and allows you to add a new plan.

To add a plan to your account:

Click the ADD PLAN button in the upper right corner of the page to open the Add a Plan lightbox.
Enter the required information in the empty fields.
To save your information and add the new plan, click ADD in the lightbox.

Plans Table

The Plans Table displays all of the plans under your account, and includes the following information:

Name: The name of the plan.
Schedule: Indicates how often the plan will incur a charge for the customer.
Amount: The transaction amount in dollars.
Status: Approved, Pending, or Voided. Hover over the icon to view details about the status.
Subscriptions: The number of subscriptions associated with the plan.

Plans Table Action

To view more details about a specific plan listed in the table, click any information in the table row to open the Plan Details page.

Note
Plan details can also be found in the Plan Tab on the Subscription Details page.

Customize your Plans Table

You can customize your view using the options at the top of the table. View the Table Search and Sort Instructions for instructions on customizing, sorting, or searching tables.

Expand the section below to view a complete list of the data that you can display on the Plans table:

Click here to view the customizations for the Plans Table.

Plan Data

Name
Schedule
Amount
Status
ID
Date Created
Description
Created by
Date Modified
Modified By
Merchant ID

Plan Details

The Plan Details page contains information about a specific plan and its subscriptions. On this page, you can add additional subscriptions and edit information about the plan.

Navigate to the Plan Details page:

Click Recurring Payments in the Payments category of the left navigation panel to open the Recurring Payments dropdown menu.
Click Plans in the dropdown menu to open the Plans page.
Locate the specific plan in the table on the Plans page, and click any information in the table row to open the Plan Details page.

Plan Details Features

Click here to view the features of the Plan Details page.

Plan Details Information Banner

The Plan Details Information banner is displayed at the top of the page and displays the total, active, and inactive subscriptions assigned to this plan.

Subscriptions Tab

The Subscriptions tab is located under the Plan Details Information banner. By default, the page will direct you to the Subscriptions tab when you open the Plan Details page. The tab contains a table of all subscriptions under the plan, and includes the following information in the default setting:

Customer: The name of the customer associated with the subscription.
Status: The status of the subscription: Active or Inactive.
Amount: The dollar amount charged each time the subscription payment recurs.
Schedule: The payment schedule: Days, Weeks, Months, or Years.
Start: The start date of the subscription.
Finish: The date that the subscription ended. Note that this date is only available for inactive subscriptions.

Subscriptions Tab Actions

To access more information about a specific subscription displayed in the table, click any information in the table row to open the Subscription Details page.

Plan Details Tab

The Plan Details tab is located to the right of the Subscriptions tab. Click DETAILS to open the tab in the page. The Plan Details tab contains editable details about the plan, including the following information:

Name: The name of the plan.
Description: An optional description of the plan.
Transaction Description: An optional description that accompanies any transactions that occur as part of the plan.
ID: The ID number associated with the plan.
Created: The date that the plan was created.
Merchant: The name of the merchant associated with the plan.
Status Drop Down Menu: The plan status: Active or Inactive.
Amount: The dollar amount charged each time the subscription payment recurs.
Schedule: The payment schedule: Days, Weeks, Months, or Years.
Schedule Factor: The number of times that the subscription is billed.
Max. Consecutive Failures: The maximum number of attempts made to charge the saved payment method for the subscription if the payment method fails or is declined. If the Max. Consecutive Failures limit is reached, the subscription will be canceled.

Plan Details Action

To edit information in the Plan Details tab:

Click the PENCIL icon in the upper right corner of the page.
Enter the information.
Click the CHECKMARK icon in the upper right corner of the page to save your edits, or discard your changes and return to the previous page by clicking the X icon.

Customize your Subscriptions table

You can customize your view using the options at the top of the table. View the Table Search and Sort Instructions for instructions on customizing, sorting, or searching tables.

Expand the section below to view a complete list of the data that you can display on the Subscriptions

Click here to view Subscriptions table customizations.