Plans & WHMCS products

Define a plan in the addon, then sync it to a WHMCS product whose module is ImpulseSecrets. The plan’s tenancy decides how a service is provisioned; its limits are applied to each service.

1. The tenancy model

A service runs in one of three tenancy modes, chosen by the plan the customer orders. Tenancy is set on the plan, and the premium tiers need a valid license.

Tenancy	Deployment	Edition
Shared	Multi-tenant instance per region; each customer gets an isolated organization / namespace	Free (works without a license)
Dedicated	One single-tenant VPS per customer, provisioned on demand	Premium (licensed)
BYOK	Dedicated VPS bound to the customer’s own external KMS	Premium (licensed)

Shared services never provision a VPS — they attach a customer organization onto an existing shared server you registered for that region. Dedicated and BYOK provision (or convert in place) a one-customer VPS.

2. Create a plan

In the addon, open Plans & Products → New Plan and define:

• Slug — lowercase letters, digits, and dashes. The WHMCS product stores it as its Plan Slug, and provisioning looks the plan up by it.
• Tenancy — shared, dedicated, or byok.
• Secrets engine — OpenBao (the default for new plans) or Infisical. Provisioning only places a service on a server running the plan’s engine, and the engine is locked once live services use the plan.
• Per-plan limits — organizations, secrets, members, projects, integrations, and custom domains, plus feature switches such as automated backups.
• Regions — the shared regions that can host the plan (leave all unchecked to allow any), optionally pinned to one shared server.
• Infrastructure — for Dedicated/BYOK, the VPS provider and size a customer’s server is built with.
• Pricing — monthly and annual prices.

Register capacity that matches

Provisioning refuses to place a service on a server whose engine does not match the plan’s engine. If a plan pins an engine and region, register at least one active shared server with free capacity running that engine in that region, or Shared Create fails cleanly with “no capacity.”

3. Create the WHMCS product

Click Sync on the plan (or Sync all active plans to WHMCS) after saving it. Sync is the WHMCS handoff: it creates or updates the orderable product, sets its module to ImpulseSecrets, stores the plan slug as the Plan Slug, copies the plan’s limits into the module settings, pushes monthly and annual pricing across currencies, hides inactive plans, and rebuilds upgrade paths between active Secrets products.

The product’s module settings:

Config option	Default	Meaning
Plan Slug	free	The slug of the addon plan the service is created from
Max Secrets	100	Per-service secret cap surfaced in the client area
Max Members	3	Workspace member cap
Max Projects	3	Project cap
Max Custom Domains	0	Custom-domain cap (premium; 0 disables)

A service takes its limits from the addon plan named by Plan Slug; Sync copies them into the Max fields above. To change a limit, edit the plan and sync again — a WHMCS configurable option with the same name as a limit (for example Max Secrets) overrides the plan’s value for an order.

The server module is a WHMCS provisioning module with RequiresServer set to false — you do not attach it to a WHMCS server row.

4. Order to a test client

Order the product to a test client to trigger CreateAccount:

• Shared services attach an organization/namespace on the picked shared server for the plan’s region and engine, and reach active quickly.
• Dedicated/BYOK services enter the provisioning queue; the provision cron (every 2 minutes) advances the box through boot, engine bring-up, custody/handshake, and promotion to active.

ChangePackage re-applies the plan’s limits (secrets, members, projects, custom domains) to the service, so a plan upgrade or downgrade flows through the standard WHMCS product change. A change from Shared to Dedicated starts a tracked migration, and Dedicated to BYOK converts the existing server in place. Shared to BYOK is refused (upgrade to Dedicated first), and so is a change to a plan on a different engine.

5. Premium features & developer keys

The Free edition is fully functional for the Shared tier. A valid license unlocks the premium feature set: dedicated, byok, backups, migration, and custom_domain. Pricing is entirely your decision — sell Shared to unlimited customers at your own retail price, and layer Dedicated + BYOK, backups, and migration on top with a license.

Developer keys

Developer keys (ISECDEV-) are not sold with the module. If you have been given one, it unlocks the premium features for testing, except custom domains, which it refuses.