Skip to content
D
Documentation

Plans

reference
5 min readUpdated

Plans

Use Plans to review subscription plans, compare their list values, and open a plan record for configuration details.

If you need to…Go to
Review the columns in the Plans listUnderstand the plan list
Narrow the list before choosing a rowFilter the plan list
Open a plan recordFind and open a plan
Diagnose an empty or failed listWhen the list cannot load
Review fields, features, or saving on an opened planContinue to plan details

Before you start

The Plans list is the starting point for reviewing saved subscription plans. Have the identifier available when you need to open a specific plan.

Before you beginWhy it matters
Have access to the Plans listYou need access before you can review plans.
Know which saved plan you need to reviewThis helps you choose the correct row when several plans are listed.

Understand the plan list

The Plans list is a grid for comparing a plan's name, price, dates, and active state before you open its record. It displays Plan, Price, Created at, Modified at, and Active.

Identify the five plan-list columns before selecting a row.
ColumnWhat it contributes to review
PlanIdentifies the plan by name.
PriceShows the plan price.
Created atShows when the plan was created.
Modified atShows when the plan was last modified.
ActiveShows the plan's active value.

The list can show No data and Count: 0. When rows are available, use the Plan value with the other columns to choose the record to inspect.

Filter the plan list

Filtering narrows the Plans grid before you choose a row. The grid provides a filter row and filters in its column headings.

Prerequisites

  • The Plans list is open.

Steps

  1. Use one of these filtering methods:

    If you want to…Use
    Filter from the gridThe filter row for the column you want to narrow.
    Filter from a headingThe filter in the column heading.

Result: The grid is narrowed to matching plan rows when rows are available.

If the grid displays No data and Count: 0, there is no plan row to select.

When the list cannot load

Use the message on screen to distinguish an empty list from an unsuccessful load.

What you seeWhat to do
No data and Count: 0Review the list state and wait for plan rows before selecting one.
An error occurred while processing your requestReturn to the Plans list and try the review again.

Find and open a plan

A plan record is the detail surface for one subscription plan. Open it from the corresponding row when you need to inspect or edit that plan.

Prerequisites

  • The Plans list is open.
  • The plan row is visible, either in the full list or after filtering.

Steps

  1. Use one of these ways to open the plan:

    If you want to…Select
    Open from the rowA data cell in the plan row.
    Open from the row’s edit linkThe row’s edit link at the end of the row.

Result: The selected plan's details surface opens.

Continue to plan details

Plan details is the record surface for reviewing the plan's limits, active value, and available features. The form contains Plan name, Plan Price, Users count, Branches count, Teams count, Roles count, and Active.

FieldWhat it is used forRule shown by the form
Plan nameIdentifies the plan on its record.Required.
Plan PriceHolds the plan price and its currency selection.Minimum 0; no required marker is shown.
Users countHolds the user limit for the plan.Required; minimum 0, maximum 99.
Branches countHolds the branch limit for the plan.Required; minimum 0, maximum 99.
Teams countHolds the team limit for the plan.Required; minimum 0, maximum 99.
Roles countHolds the role limit for the plan.Required; minimum 0, maximum 99.
ActiveEdits whether the plan is active.A check box; no required marker is shown.

The capacity values are carried by the plan record and are used as limits in the corresponding branch, warehouse, team, role, and user administration surfaces.

When feature rows exist, the feature grid provides Feature and Selected columns. Select a feature row to add or remove that feature from the plan. The record also provides a currency picker with Plan Price.

Validate and save a plan

Enter the plan values, then submit the changes with Save.

Prerequisites

  • A plan record is open.
  • You know the values to enter for the plan fields.

Steps

  1. Enter the plan values in the fields below:

    FieldValue or action
    Plan nameEnter the plan name.
    Plan PriceEnter a value of at least 0, then choose its currency.
    Users countEnter a value from 0 through 99.
    Branches countEnter a value from 0 through 99.
    Teams countEnter a value from 0 through 99.
    Roles countEnter a value from 0 through 99.
    ActiveSelect it when the plan must be active.
    Feature rowSelect it when you need to add or remove the feature from the plan.
  2. Select Save after the form shows the changes you want to submit.

Check that Save is disabled before changes and available after unsaved changes.

Result: Save is enabled when the record has unsaved changes.

If a required field is empty, the form displays This Field Is Required. If the plan name contains a disallowed character, it displays Just '_'‘-''.' And '&' Characters Accepted. Correct the value shown by the message before selecting Save again.

The record opens with Save disabled until the form has unsaved changes.

Plan list actions

The Plans list has no mounted create control, and its Cancel and Delete controls are not mounted.

Was this page helpful?

Need help using the product?