Manage pricing plans
Create and edit the plans the pricing page lists and checkout sells, in every language, from the admin console.
/pricing shows the active plans, and checkout charges the price saved on the plan. You manage plans at /admin/plans. Price, currency, interval, credits, status and order belong to the plan and apply to every language. The name, description, button label and feature list are written per language.
Before you begin
- An admin account with
plans.readto see the page andplans.writeto save. The Commerce Manager role has both. See Roles and permissions. - A payment provider, if buyers should be able to pay. See Connect a payment provider.
- A decision on the plan key. Orders and subscriptions refer to it, so it cannot change after the plan is created.
Create a plan
Open Plans
Go to Commerce → Plans (/admin/plans). The page counts all plans, those on the pricing page, hidden ones and subscriptions, and lists each plan with its price, credits, languages and status. Click New plan, which opens /admin/plans/new.
Fill in the plan
| Field | Rule |
|---|---|
| Plan key | Lowercase letters and digits separated by single hyphens or underscores, up to 64 characters; new is reserved. Fixed after creation |
| Price | In the currency's main unit, for example 29 or 29.50; zero is allowed. Stored in minor units |
| Currency | A three-letter code such as USD or CNY |
| Billing interval | Per month, per year, one-time or lifetime |
| Credits granted | A whole number of zero or more, added to the buyer's balance when the order is paid |
| Show on the pricing page | On makes the plan active; off hides it and checkout refuses it with plan_inactive |
| Order | A whole number; plans are listed in ascending order |
The interval sets how the plan is billed. Monthly and yearly plans are subscriptions. One-time and lifetime plans are a single payment. The form shows which one applies.
Write the copy for each language
Under each language, fill in Name, Description, Button label and the Features list. Tick Included for a feature the plan has. An unticked feature is shown as not included. Features without a label are dropped.
English is required. A language whose name is left empty gets no row for the plan. /pricing and checkout in that language use the English row, including its feature list. Fill in every language you publish the pricing page in.
Save
Click Create plan. When a save is rejected, the form shows the problem, for example a duplicate plan key or an invalid currency, and nothing is written.
Edit a plan
Open the plan from the list and click Save plan when done. Saving writes the shared fields to every language row and replaces each language's copy and feature list with the form's contents. Clearing a language's name removes that language's row and its features.
A new price affects new checkouts only. Existing subscriptions keep what the payment provider already charges.
If the list warns that some plans have language rows that disagree on price, interval or credits, open each such plan and save it once. Saving writes the same values to every language row.
WeChat Pay and Alipay charge a plan only when it is priced in CNY and billed as a single payment. With either enabled, CNY plans are charged through it, WeChat Pay first, and other currencies through the active provider. Waffo sells a plan only through the Waffo product that matches it: a one-time plan needs the one-time product, a monthly or yearly plan the subscription product of its interval.
Verify the plan
- Open
/pricingin each language. The plan appears in its place with that language's name, price and features. A hidden plan does not appear. - Sign in as a normal user and buy the plan with the provider's test card.
/admin/ordersshows the order at the plan's price, and the plan's credits appear on the buyer's/app/credits. /admin/auditlistsbilling.plan.createdorbilling.plan.updatedwith your account as the actor and the plan key as the target.pnpm validate:pricing-planspasses.
Troubleshooting
Checkout answers amount_mismatch
The page was loaded before the price changed. Checkout compares the amount, currency and mode the browser sent with the saved plan and rejects the request when they differ. Reload the page.
Checkout answers plan_interval_mismatch
The plan's row bills as a subscription but does not renew monthly or yearly, or the reverse. This happens only to rows written outside the console. Open the plan on /admin/plans and save it. The interval then sets the billing mode.
A plan shows English copy on another language's pricing page
That language has no row for the plan, so the page shows the English row. Open the plan and give it a name in that language.
Next steps
Sell products and plans
Your products appear on the storefront with a price; buying one issues a licence the buyer activates with a GitHub username.
Manage orders, refunds and subscriptions
You can refund an order, cancel or resume a subscription, let buyers manage their billing and re-apply a failed webhook.