README

Tariffs as a section of the WebX UI admin panel: price cards with a name, a badge ("30 HOURS / 25$"), a price in a currency of the site's list — or words instead of one ("On request") — a period, what the plan includes, a description, one button and a "recommended" mark. Gathered in flat groups ("For individuals", "For business") and, when the site has services, linked to the services they are for. Shown on any page as a block (a slider or a grid) and in the site's own templates through tariffs().

The module has no public route and no page of its own. A tariff reaches the site in a block: "pricing" as a slider on the Pricing page, "what it costs" as a grid on a service's page. The page brings the address, the SEO and the menu entry; the module brings the cards.

Requirements

• PHP 8.3+, Laravel 13
• webx-ui/module-admin, webx-ui/module-blocks, webx-ui/localization, webx-ui/routing
• webx-ui/module-pages for a page to put the block on — suggested, not required
• webx-ui/module-services to link tariffs to services — suggested, not required

Install

composer require webx-ui/module-tariffs
php artisan migrate
php artisan webx:blocks:offered --install --module=tariffs

The last line puts the offered block type Tariffs on the site and publishes it. A type the site already has under the slug tariffs is left alone: the site may have rewritten it. webx:setup runs this line by itself for a new site.

Permissions: tariffs.view, tariffs.manage, and tariffs.groups.manage for the groups — the tabs of a page of prices are a different job from the price on a card. The section is a group of the panel's menu, Tariffs, with two entries: Tariffs and Groups.

A tariff

No draft and no history: a save is what the site shows, at once. Deleting puts a tariff in the bin, and it comes back to its places.

Nobody is hidden over a language. A published tariff is shown in every language. The name, the badge, the period and the words instead of a price fall back to the default language — a price without "/mo" on a Russian page reads as a one-off payment, which is worse than an English word. The description is printed only in the language it is written in. A row of "what is included" not written in the language drops out of the list there. A button without a label in the language drops out, the tariff stays.

Zero is a price. 0 prints as "$0"; "Free" is the words instead of a price with no number.

Configuration

// config/webx-tariffs.php
'currencies' => ['USD' => '$', 'EUR' => '€', 'UAH' => '₴', 'PLN' => 'zł'],
'variants' => ['primary' => 'Primary', 'secondary' => 'Secondary', 'link' => 'Link'],

• Currencies — ISO code → the symbol the site prints. A key that is not three capital letters is skipped. The select of the form offers them as "USD — $".
• Button looks — key → label for the panel (a string or a translation key). The key is what the template turns into a class, b-tariffs__button--secondary.
• Taking a currency or a look out of the list locks nothing: a tariff that has it keeps it and saves it back; a tariff that does not cannot choose it (422). On the site a lost currency prints as its code, a lost look as the first one of the list.

Two roads into a template

The block. The offered type has a wx-collection field on the tariffs source. The editor of the page chooses groups, a limit and, when the site has services, "only related to" — some services, or the service of this page. The template gets the cards already read:

@foreach ($tariffs['items'] as $tariff)
    <article id="{{ $tariff['anchor'] }}">
        <h3>{{ $tariff['name'] }}</h3>
        @if ($tariff['price'] !== null)
            <p>{{ $tariff['symbol'] }}{{ $tariff['amount'] }} {{ $tariff['period'] }}</p>
        @else
            <p>{{ $tariff['price_text'] }}</p>
        @endif
    </article>
@endforeach

tariffs(). A template of the site, or a block that wants something the field does not do, asks for them itself:

@foreach (tariffs()->categories() as $group)
    <h2>{{ $group['title'] }}</h2>
    @foreach ($group['tariffs'] as $tariff) … @endforeach
@endforeach

A group has no slug: a string that is not a number is a filter nothing passes, not "all". relatedTo() with an empty list is none.

Both roads hand over the same card:

[
    'id' => 7,
    'anchor' => 'tariff-7',
    'categories' => [2],               // the ids of its groups
    'name' => 'Combo Starter',
    'badge' => '30 HOURS / 25$',       // '' when there is none
    'price' => 750.0,                  // or null
    'amount' => '750',                 // the number as the page's language writes it; '' without one
    'currency' => 'USD',               // or null
    'symbol' => '$',                   // the code for a currency the config lost; '' without one
    'period' => '/mo',
    'price_text' => '',                // printed when price is null
    'features' => ['Design', 'SEO'],   // the rows written in the language
    'description' => '…',              // '' when it is not written in the language
    'button' => ['label' => 'Get started', 'url' => '/contacts', 'new_tab' => false, 'rel' => null, 'variant' => 'primary'], // or null
    'featured' => true,
    'service_links' => [['id' => 3, 'title' => 'SEO', 'url' => '/seo']], // [] without services
    'fields' => ['note' => '…'],       // the project's own fields, by name
]

amount is formatted by the package — no fraction when it is zero, two digits otherwise, the separators of the language — because the symbol's place is the template's: "$750" or "750 $". A list of any length is the same few queries. tariffs() is declared only if the site has no function of that name; php artisan webx:doctor says whose it is.

The Tariffs block

The type is a document in resources/blocks/tariffs.json, the same format as webx:blocks:export: a heading, the tariffs collection, a layout, columns, the words over the list ("This plan includes:") and the label of a recommended card.

• Slider — the untouched layout: a ribbon that snaps, one card on a phone, columns across on a wide screen (3 when not set), with arrows and a count "01 / 03". Without JavaScript it scrolls sideways by finger and shows no count; with every card in view it shows neither. No autoplay: prices are compared, not watched.
• Grid — columns across, a stack on a narrow screen; the cards of a row are one height and the button is pressed to the bottom.
• A card is an <article id="tariff-7">: the badge, the name, the price (symbol, amount and period, or the words — neither, no line), the words over the list and the list with ticks drawn by CSS (two columns past four lines), the description, links to the services, and the button with the class of its look. A recommended card gets is-featured and its label over it.
• The symbol stands before the number. For "750$", swap the two in the site's copy of the type.
• The styles are neutral — currentColor, Canvas and em — so the block stands in any design.

No markup. An Offer needs something it offers and a page of it; a tariff has neither, and on a service's page the Service markup is the services module's to print.

The panel's API

Under the panel's API path, behind tariffs.view to read and tariffs.manage to write:

GET    tariffs              ?category=&trashed=1&search=  → { data: [row], filters: { categories } }
POST   tariffs              { values }                    → 201 { data: { tariff, values } }
GET    tariffs/{id}                                       → { data: { tariff, values } }
PUT    tariffs/{id}         { values }                    → 422 under the name of the field
DELETE tariffs/{id}
POST   tariffs/{id}/restore                               → { data: row }
POST   tariffs/reorder      { ids, category? }
       tariffs/categories/* the shared routes of categories, behind tariffs.groups.manage to write

A row is { id, name, badge, price, currency, symbol, period, price_text, featured, published, position, categories: [{ id, title }], updated_at, deleted_at }; tariff is { id, name, published, deleted_at }. Refusals land under name.<default language>, price, currency, button_variant, button_link (a label without a link) and features.<n>.text — the row as the editor counts them, empty ones included. Empty rows of the list are dropped.

MCP

With webx-ui/mcp serving the panel to an agent, the section is six tools behind tariffs:read and tariffs:write — the same list, form and order code as the panel:

The groups are tariff_groups_list, _create, _update, _delete and _reorder — the tools every module's categories have, behind tariff-groups:write.

A tariff is named by its id; a group by its id or its title in any language. A plain string in a translated field is the default language. price is a number or null. currency is a code of webx-tariffs.currencies; features a list of lines, each a string or a map of languages; button is { label, link, variant } — link an address or an entity as menu_add_link takes it — and null takes the button away. A currency or a look the site does not have is refused before the form, with the keys it has; one the tariff already has, taken off the list since, goes back as it came. services takes ids or addresses and is offered only when webx-ui/module-services is installed. Every change takes dry_run: true, and tariffs_create is one transaction: a refusal leaves nothing behind.

The resource tariffs://catalog is what an agent reads first: the currencies and the looks the site accepts, then every group in order with its tariffs in the group's order — unpublished ones included and marked — each with the price in one line, featured, written_in (the languages of the name and of the description) and its services; the tariffs in no group at the end.

Demo

php artisan webx:demo seeds one group, «For business», and three tariffs from resources/demo/tariffs.json, in English and Russian as far as the site has them: Combo Starter ($750 /mo, one line of the list only in English — the Russian list is a line shorter), Combo Growth (recommended, $1,380 /mo, linked to a demo service) and Combo Enterprise (no number, «On request»). The buttons lead to a page of the pages demo, else to the first page of the address registry; without pages there are no buttons. The offered block type is installed if the site has not taken it, and then:

• with webx-ui/module-pages — a page /pricing with every tariff in a slider of three columns;
• with webx-ui/module-services — a grid of «what it costs» (the service of this page) on the demo service company-website, where Growth is the one shown.

The demo needs the pages' and services' demos first when they are installed. webx:demo --remove takes all of it back out. A site that already has any tariff is left alone.

License

MIT