All guides
Admin

Coupons

Configure offers, claims or customer reward records.

Step-by-step guide

Before you start

Use an administrator account for this feature.

Open this feature

Open /admin/coupons on your application domain. The tasks below name the controls to use after opening the page.

Steps

Prepare at least one paid plan. Coupon rules affect checkout; use a test plan when checking a new rule.

Create a coupon for a selected plan

  1. Open Coupons and select Create coupon.
  2. Enter a Name such as Test discount and a unique Code such as TEST10.
  3. Set Status to Enable. In Coupon by, choose Percent and enter 10 in Discount value for this example.
  4. Set Usage limit to 1 for this test. Use -1 only when unlimited redemption is intended.
  5. Choose Start date. Optionally choose End date on or after Start date.
  6. In Allow for plans, select the paid test plan. Do not use Select all unless the discount should apply to every listed plan.
  7. Select Create coupon. Use Edit to check the code, dates, selected plans and discount. Editing submits with Save changes.

Fields shown in the interface

Field or settingWhat to enter or choose
NameRequired, up to 255 characters.
CodeRequired, unique, up to 32 characters. The source trims it and stores it in uppercase.
Coupon byPercent for a percentage discount; Price for a fixed amount.
Discount valueA non-negative number. In this example, Percent with 10 means a 10% discount.
Usage limitWhole number; -1 means unlimited.
Start date / End dateStart date is required. End date is optional and cannot precede Start date.
Allow for plansSelect at least one eligible paid plan.

Check the result

  • Reopening the coupon shows the intended scope, date window and usage limit.
  • In a test checkout, check the discount and final total before making any payment. A saved coupon alone does not prove checkout redemption.

Problems and validation

ProblemWhat to do
Code already existsUse another unique code or edit the existing coupon.
No eligible plan is selectedSelect an offered paid plan.
Coupon does not apply at checkoutCheck status, selected plan, date window and usage limit before retrying.

Technical reference

Sources for these task instructions
Role-scoped source references

Pinned commit: 40d27448e4517301d3d8f5a27ca0c7531c51f136

Source-only route information
MethodSource-default route
GET/admin/coupons
Unmapped fields — not user instructions

These fields belong to this role’s source handler, but their screen labels were not confirmed.

Source keyHandler
start_datemodules/AdminCoupons/Livewire/CouponIndex.php
end_datemodules/AdminCoupons/Livewire/CouponIndex.php
plansmodules/AdminCoupons/Livewire/CouponIndex.php