Accounts
Top-up Codes
Top-up Codes let users extend or replenish their access without admin intervention. A user enters the code on the captive portal and the associated quota or time is added to their account immediately.
'alt' => 'Dashboard overview', 'caption' => 'The default Kiwire dashboard layout', 'screenshot' => true, 'class' => '', ]) Drop images into: public/assets/img/docs/{page}/{filename} --}}
Image not uploaded yet
public/assets/img/docs/topup-codes/overview.png
Key Fields
| Field | Description |
|---|---|
code | The alphanumeric code the user types on the portal (max 20 chars, unique per tenant) |
status | n = unused · y = redeemed |
price | Display price for the code (informational) |
plan_name | Label shown to the user on the portal when redeeming |
quota | Bytes to add to the user's quota allowance |
time | Seconds to add to the user's session time allowance |
username | Populated once redeemed — records which account used it |
date_activate / date_expiry | When the top-up grant is valid (the added quota/time expires on this date) |
bulk_id | Batch identifier for grouped codes |
Generating Codes
Click Generate and fill in:
- Quantity — number of codes in the batch
- Plan Name — display label for the top-up
- Quota / Time — what the code adds (one or both)
- Price — informational display price
- Code Prefix & Length — controls the format of the generated code
- Validity Period — how long after redemption the added allowance lasts
Actions
- Reset — clears the redemption record and marks the code as unused again
- Delete — removes the code permanently (only unredeemed codes can be deleted without data impact)
How Users Redeem
On the captive portal, users see a Top-up Code input field (if the Login Method is configured to show it). They enter the code, which is validated and applied to their session immediately. The code is then marked status = y and cannot be reused.
Required Permissions
view-topup-codes · create-topup-codes · update-topup-codes · delete-topup-codes