Plans
Set the plan settings and the features or limits controlled by the plan.
Before you start
Use an administrator account for this feature.
Open /admin/plans on your application domain, or use the matching item in the application menu.
Steps
Example: create a test plan
Use a new test plan rather than changing a plan assigned to customers.
- Open the Plans list and select Create plan.
- Enter Starter Test in Name. Leave Slug empty if you want the form to generate it.
- Set Status to Enable. Choose the intended Currency and enter 10.00 in Price for this example.
- In Payment Frequency, choose Monthly. Choose No for Free Plan and No for Default signup plan.
- Review feature allowances and limits for the test plan. Do not grant every feature merely to bypass a permission error.
- Select Create plan. Reopen the plan from the list and check the saved values. When editing an existing plan, the submit label is Save changes.
| Field | Example selection |
|---|---|
| Name | Starter Test |
| Status | Enable |
| Currency | USD, if available for the test site |
| Price | 10.00 |
| Payment Frequency | Monthly |
| Free Plan | No |
| Default signup plan | No |
Fields shown in the interface
Only fields traced to this role’s handler and its own view are listed. The application can show separate create/edit forms; do not fill every row on one screen.
Form 1 — fields shown in the interface
| Field | What to enter or choose |
|---|---|
| Name | Required. No more than 255 characters. |
| Slug | Optional, unless this form asks for it. No more than 255 characters. |
| Status | Required. Choose Enable, Disable. |
| Featured | Required. Choose Yes, No. |
| Currency | Required. Saved as :code. Pricing cards will use :symbol for :name. / Choose the billing currency for this plan. |
| Price | Optional, unless this form asks for it. Enter a number. At least 0. |
| Payment Frequency | Required. Choose Monthly, Yearly, Lifetime. |
| Free Plan | Required. Choose Yes, No. |
| Default signup plan | Required. Choose No, Yes. |
| Trial day | Optional, unless this form asks for it. Enter -1 for unlimited. Enter a whole number. At least -1. |
| Position | Optional, unless this form asks for it. Enter a whole number. At least 0. |
| Description | Optional, unless this form asks for it. |
Check the result
After a source-checked procedure, verify the same record in the same workspace. Check saved values, visible state and access with the intended test account. An external payment/message/provider action needs its own result check.
Problems and validation
| Problem | Next step |
|---|---|
| A field rejects the value | Check its named error, the form’s visible choices and the relevant limit. Do not substitute internal numeric codes for the displayed options. |
| The control is missing | Check role, plan, enabled app and current record state. Do not grant administrator access merely to complete a User task. |
| The saved result is unexpected | Reopen the same record and verify its owner/workspace before repeating the action. |
Messages defined for this screen
| Message | What to review |
|---|---|
| The default signup plan must also be a free plan. | Check the related field or action in this role’s form. |
| The default signup plan must be enabled. | Check the related field or action in this role’s form. |
Technical reference
Role-scoped source references
Pinned commit: 40d27448e4517301d3d8f5a27ca0c7531c51f136
Source-only route information
| Method | Source-default route |
|---|---|
| GET | /admin/plans |
| GET | /admin/plans/create |
| GET | /admin/plans/{plan}/edit |
Unmapped fields — not user instructions
These fields belong to this role’s source handler, but their screen labels were not confirmed.
| Source key | Handler |
|---|---|
| permissionsState | modules/AdminPlans/Livewire/PlanForm.php |