Settings reference
Every tab and field under Settings, with what it does and its default value.
Settings holds your business details, billing rules, email, payments, security, support and knowledge base options. This article walks through each tab in the order they appear.
Only administrators can open Settings. Each tab has its own save button at the bottom (for example Save billing settings), and saving applies the whole tab at once. If any field is invalid, nothing on that tab is saved and the problem fields are listed at the top. A Discard button appears once you have changed something.
If you clear a field and save, the stored value is removed and the default shown below applies again. Password and secret fields show Set after saving and are never displayed again; use Replace to change one, and leave it alone to keep it.
The tab bar also has a Tax rates link at the end. It opens a separate page, described in Taxes and currencies.
General#
Your business#
| Field | Default | Notes |
|---|---|---|
| Business name | The installation name | Required. |
| Contact email | None | Receives admin notifications such as accepted quotes and provisioning failures. |
| Address | None | Printed on invoices. |
| Tax / VAT number | None | |
| Brand colour | #0e7c86 |
Adjusted automatically if hard to read. |
| Logo URL | None (the Tidemark mark is used) |
See Company details and brand.
Client accounts#
| Field | Default | Notes |
|---|---|---|
| Allow self-registration | On | Visitors can create their own client account. Turn off to create accounts yourself. |
Billing#
Invoicing#
| Field | Default | Notes |
|---|---|---|
| Store currency | The currency chosen at install (USD unless changed) | The default for new clients and the fallback for product prices. |
| Invoice number prefix | INV- |
|
| Quote number prefix | QUO- |
|
| Payment terms | 7 days | How long customers have to pay a new invoice. |
Under the Quotes heading:
| Field | Default | Notes |
|---|---|---|
| Quote validity | 30 days | |
| Invoice automatically when a quote is accepted | On |
Under Invoice documents:
| Field | Default | Notes |
|---|---|---|
| Attach the PDF to invoice emails | On | New invoice, reminder and receipt emails include the invoice as a PDF. |
| PDF paper size | Automatic (by client country) | Or A4, or US Letter. |
| Payment instructions | None | Bank details or other instructions printed on unpaid invoice PDFs. |
| Default terms | None | Printed at the foot of new invoices and quotes. |
Recurring billing#
Renewal invoices and what happens to unpaid services. Runs daily from the cron job.
| Field | Default | Notes |
|---|---|---|
| Create renewal invoices | 14 days before due | |
| Reminder schedule (days from due date) | -3,1,7,14 |
Comma-separated. Negative numbers are before the due date. |
| Suspend unpaid services | 5 days overdue | 0 turns automatic suspension off. |
| Terminate suspended services | 30 days overdue | 0 turns automatic termination off. |
See Recurring billing.
Trials and plan changes#
| Field | Default | Notes |
|---|---|---|
| Let customers change plan themselves | On | Also needs Customers can change plan on the product. Staff can always change plans. |
| Remind customers before a trial ends | 3 days before | 0 turns trial reminders off. |
| Create the first invoice | 0 days before trial ends | 0 invoices when the trial ends. |
See Free trials and Plan changes.
Cancellations#
| Field | Default | Notes |
|---|---|---|
| When a cancellation takes effect | At the end of the billing term | Other choices: Immediately, Let the customer choose. Staff can always choose. |
| Refund the unused time when a service is cancelled immediately | Off | Prorated by the day from the latest payment and sent back through the original payment method. Staff can untick it for a single cancellation. |
See Cancellations.
Automatic payments#
Charging customers' saved payment methods. Runs hourly from the cron job.
| Field | Default | Notes |
|---|---|---|
| Charge saved payment methods automatically | On | Only for customers who turned automatic payment on for a saved method. |
| Charge saved payment methods | 0 days before due | 0 charges on the due date. |
| Charge renewal invoices as soon as they are created | Off | Instead of waiting for the due date. |
| Retry failed payments (days after the first attempt) | 1,3,5 |
Comma-separated. The customer is emailed after each failure. |
| Maximum attempts per invoice | 4 | The first charge plus retries. After the last failure autopay stops for that invoice and the customer and admin are notified. |
Email#
Under Outgoing email, with a Sender and a Mail server part. Save before sending a test, because the test uses the saved settings.
| Field | Default | Notes |
|---|---|---|
| Send emails | On | Turn off to stop all outgoing mail, for example while testing. |
| From address | None | |
| From name | None | |
| Method | Use server default (.env) | Or SMTP, Sendmail, or Log only (testing). |
| SMTP host | None | |
| SMTP port | 587 | |
| Encryption | STARTTLS (587) | Or SSL/TLS (465). |
| SMTP username | None | |
| SMTP password | None | Stored as a secret. |
Send test email sends a short message to the address you are signed in with and reports success or the error. See Email.
Payments#
Lists each enabled gateway plugin with an on/off switch, a Name shown to customers, its credentials and the webhook address to add in the provider. Without a gateway plugin the tab shows No payment gateways installed. See Payment gateways.
Security#
| Field | Default | Notes |
|---|---|---|
| Require two-factor authentication for staff | Off | Staff and administrators without it are sent to set it up before they can use the admin area. |
Staff and customers can protect their own logins from their security page. If someone is locked out, run php artisan billing:reset-2fa [email protected] on the server. See Two-factor sign-in.
Support#
Support tickets#
| Field | Default | Notes |
|---|---|---|
| Enable support tickets | Off | While off, every ticket page and endpoint is hidden. When on, adds Tickets, Departments and Ticket fields to the admin menu and Support to the client area. |
| Ticket number prefix | TKT- |
Quoted in email subjects so replies attach to the right ticket. |
| Email staff about new tickets and customer replies | On | Goes to the department's staff, and to the assignee when a ticket is assigned. |
| Email the customer when a ticket is closed | On | |
| Reject email from people without a client account | Off | When on, mail from an address that matches no customer is ignored instead of opening a ticket. |
Attachments#
| Field | Default | Notes |
|---|---|---|
| Largest file (MB) | 10 | |
| Files per message | 5 | 0 turns attachments off. |
| Allowed file types | Blank | Comma-separated extensions, for example png, jpg, pdf, txt, zip. Blank allows anything not blocked. Executables, scripts, HTML and SVG files are always refused. |
See Support tickets.
Knowledge base#
| Field | Default | Notes |
|---|---|---|
| Enable the knowledge base | Off | Adds Knowledge base to the admin menu and Help center to the client area. The public address is /kb. While off, every knowledge base page is hidden. |
| Let guests read it | On | When off, only signed-in people can read articles. Drafts and hidden categories are never shown to customers. |
| Title | Help center | The heading on the knowledge base home page. |
| Introduction | Guides and answers to common questions. | One or two sentences under the title. |
See Knowledge base.
System#
This tab has no save button because it holds information and actions rather than fields.
- This installation shows the version, PHP version, database, queue, cache and plugins folder. It is useful when asking for support.
- Scheduled tasks shows the command-line cron entry to copy (recommended) and, for hosts without command-line cron, a web cron URL to call every minute. Generate URL or Regenerate URL makes a new secret address and invalidates the old one, so update your cron job afterwards. Anyone with the URL can start a run, so keep it private. Run billing tasks now runs everything once and reports what it did. See Cron job.
- PDF fonts for Chinese, Japanese and Korean lets you install or remove optional font packs with Install, Remove or Install all font packs. Each is a one-time download checked against a fixed checksum. See PDF and fonts.