Skip to content

Self-serve Sign-up and the Plan Catalogue

Someone picks a plan on the pricing page, enters a card and has a working shop with its admin open in a couple of minutes. This page covers the sign-up pages, how the shop is built afterwards, the public plan catalogue (GET /v1/public/plans) and the pricingTable block that shows it. Plans themselves, and what a shop on each may use, are described in Subscription Entitlements.

The plan catalogue

One read-only view of the published plans feeds the pricing table, the sign-up pages and the API, so the three can never disagree on a price. A plan appears when it is public and active and has at least one active base price. Plans sold only by the sales team (Charity, custom plans), drafts and retired plans are left out. An unlisted plan isn't on the pricing page, but someone with its sign-up link (/start?plan=<slug>) can take it.

For each plan the catalogue gives:

  • its slug (the stable identity sign-up links use; names can change), name, description, family and order;
  • its price per interval (monthly, yearly), ex VAT in minor units;
  • the price of each extra location, when it sells them;
  • the free trial (a card is taken either way);
  • the founding offer, only while it is open, with places left;
  • the setup fee and when it is waived (yearly, founding);
  • the limits (products, admins, locations, staff and monthly customers per location, bookings);
  • highlight bullet points (message keys, worded in the visitor's language);
  • the public add-ons it can take, priced for that plan;
  • Badger's fee on each paid order (a percentage and a fixed amount), on top of Stripe's own processing fee, which the shop pays Stripe directly: payments are made on the shop's own Stripe account, and Badger's fee is taken from each one as an application fee;
  • for a plan sold through a conversation (Enterprise), its "Talk to us" link.

Payment-provider ids, the edition and capability overrides are never included.

GET /v1/public/plans

Public, unauthenticated and platform-wide: it doesn't depend on the request Host. The answer is cached for five minutes (Cache-Control: public, max-age=300). Alongside the plans it says that prices exclude VAT and gives the sign-up URL. The full shape is in the API reference.

The pricingTable block

pricingTable renders the catalogue on Badger's own marketing site. Each plan gets a card with: - its price and "+ VAT"; - its card fees ("Card fees: Stripe's rate + 0.5% + 5p an order"); - the founding price and places left; - trial, limits, highlights, add-ons and setup fee; - a Start free trial button to /start?plan=<slug>&interval=year|month. A plan with a "Talk to us" link gets a Talk to us button to that link instead.

Every price is a monthly figure. Billed yearly, the card shows a twelfth of the yearly price, to the nearest penny, as "a month + VAT, billed yearly". Extra locations and add-ons are shown the same way.

The Yearly / Monthly switch sits above the cards, with yearly first. It changes the prices and the buttons together. When paying yearly costs less on every plan sold both ways, the switch says by how much ("Yearly: save 20%"), using the smallest saving of any plan so the label is true of every card. Without JavaScript the configured interval shows. It is built for the Nova family of themes; on any other theme the block renders nothing (the page still loads).

Setting
heading Optional heading
families Only these plan families, comma-separated: RETAIL, HOSPITALITY, ENTERPRISE. Empty for all
defaultInterval year (default) or month
showAddOns List each plan's add-ons (on by default)

It shows Badger's plans, not the shop's products, so it only makes sense on Badger's own site. It renders nothing when no plan is on sale. Prices are changed on the plan, never on the block.

Signing up at /start

The sign-up pages live in the auth portal (https://auth.bdgr.co.uk/start), which already owns Badger accounts and emailed sign-in codes, so the owner ends up signed in everywhere.

  1. Your shop and plan. Shop name, web address, kind of business (shop, charity, restaurant or takeaway, bookings), email; the plan and monthly or yearly; any add-ons, extra locations, the founding place while the offer is open, and a promotion code. Pricing links can preselect the plan, interval, add-on (&addon=) and code (&code=). The web address is suggested from the shop name and checked as it is typed.
  2. Confirm your email. The usual emailed six-digit code (or the link in the email). An owner already signed in with that address skips this; an owner adding a second shop reuses their billing account.
  3. Check your plan. What they will pay each month or year, plus VAT; the setup fee or that it is waived; the trial. Then Stripe Checkout. A card is required for every trial, whatever the plan; nothing is charged until the trial ends.
  4. Building your shop. Back from Stripe, the page waits for the shop and then opens its admin. If building takes longer than usual, the page says so and gives a reference.

Coming back from Stripe without paying, or reopening the page later, picks the sign-up up at step 3 with a fresh checkout for the same choices. If the checkout was in fact paid (the owner pressed back before Stripe sent them on), the shop is built from it instead, so nobody pays twice.

The web address

The address is <site id>.bdgr.co.uk. The site id is 3 to 40 lower-case letters, numbers and single hyphens, starting with a letter. Addresses the platform uses (www, api, auth, admin, …) are refused, as are ones a shop already has, as its id or as a domain. An unfinished sign-up holds its address for a day (the life of a checkout); one being built holds it for good, against its own owner too. An owner starting again isn't blocked by their own earlier, unpaid try, which is given up. The live check as you type never sends your email address in the page address.

Protection against abuse

  • Cloudflare Turnstile on the first page, once both its keys are set in System › Global configuration (signup-turnstile-site-key, signup-turnstile-secret-key). Changes there apply straight away, with no restart. If Cloudflare can't be reached the sign-up goes ahead (the limits and the card still stand).
  • Hourly limits: 10 sign-ups per IP address and 5 per email address by default. Emailed codes have their own limits.
  • Disposable email domains are refused (a configurable list).
  • The card at checkout is the main check: one trial per account.

IP and email addresses are only ever stored as hashes for the limits, and never logged.

Building the shop

The sign-up moves through STARTED → VERIFIED → CHECKOUT → PROVISIONING → READY, or FAILED. The shop is built once its checkout completes, whichever arrives first: the billing webhook for the completed session, or the owner's return from Stripe. Both are safe to repeat, so the shop is built once. A web node picks up sign-ups waiting to be built within a few seconds.

Building a shop:

  1. creates the site at its web address, in demo mode (the storefront is behind the demo password until launch; admin, its sign-in and its "confirm it's you" step are not, so the owner gets straight in);
  2. switches on central sign-in, so the owner signs in to admin with their Badger account. Confirming it's them before a sensitive change (changing who can do what, say) also goes through their Badger account, by passkey or an emailed code, since they have no password on the shop;
  3. applies the template for the kind of shop and plan:

    Template When Theme Switched on
    Retail Retail plans, unless a bookings business Nova
    Bookings Bookings plan, or a bookings business Nova Bookings (appointments, or tables for a restaurant)
    Takeaway Takeaway plan Bistro Restaurant ordering
    Restaurant Restaurant plan Bistro Restaurant ordering, table bookings, table service, POS

    The plan's entitlement still decides what the shop may use, so a template can't grant more than the plan; 4. makes the owner the shop's admin; 5. records the platform subscription as self-serve, trialling or active, with the price, add-ons, extra locations, founding lock and setup fee status Checkout charged. The shop's entitlement follows from it; 6. sends the welcome email (from Badger, with the plan, the trial end when there is a trial, and a link to the admin).

The settings are written by a background build outside the shop, so once they are in the shop's caches are cleared (SiteCacheService.evictAll): nothing read before, such as central sign-in being off, can outlive the build.

Each step keeps what an earlier try made, so a retry never makes a second site or subscription. If a shop can't be built after the customer has paid (for example its address was taken in the meantime), the sign-up fails with a reason and Badger staff are told at once; the founding place is kept, as the customer is paying the founding price. The customer's page then gives a reference and the support address instead of "Start again", so nobody is invited to pay twice; a sign-up that fails before checkout still offers "Start again". A checkout that expires unpaid gives its founding place back. Sign-ups that never reach checkout are given up after a week.

Configuration

Property Default
badger.signup.shop-domain-suffix .bdgr.co.uk The domain new shops get a subdomain of. The global setting signup-shop-domain-suffix (System › Global configuration) overrides it, so the demo platform sets .bdgr-demo.co.uk there
badger.signup.start-url https://auth.bdgr.co.uk/start The sign-up page the pricing table and the API link to
badger.signup.support-email [email protected] The address a customer whose shop couldn't be built after payment is asked to write to
badger.signup.turnstile.site-key, badger.signup.turnstile.secret-key blank (off) Cloudflare Turnstile keys for the sign-up form. The global settings signup-turnstile-site-key and signup-turnstile-secret-key (System › Global configuration) override them, so each environment can use its own widget without a deployment change
badger.signup.rate-limit.ip-per-hour, badger.signup.rate-limit.email-per-hour 10, 5 Sign-ups started per hour
badger.signup.blocked-email-domains a short list Disposable email domains refused
badger.signup.provisioning-sweep.enabled true Whether this node builds waiting shops
badger.signup.provisioning-sweep.interval-ms 5000 How often it looks

Sign-up says "isn't open yet" until platform billing (the Stripe side) is deployed and the global setting self-serve-signup-open (System › Global configuration) is on. The setting is off by default, so a demo or test environment with Stripe configured takes no sign-ups; turn it on only where plans are sold. While it is off, /start takes no new sign-ups (ones already started still finish) and the pricing table and /v1/public/plans still show the plans. If the setting can't be read, sign-up stays closed.