This is a preview of unreleased docs from main. View the published docs
Skip to main content

Plan Fields

Plans come with a name, price, and duration. Plan fields let you record anything else your organization needs to know about a plan, such as a seat limit, a tier label, or an internal cost code. You define the fields once, then fill in a value for each plan.

Define a field​

Open Organization Settings → Plan Fields and select New field.

SettingDescription
NameThe label shown when you edit a plan.
SlugA short identifier using lowercase letters, numbers, and underscores. It cannot be changed later.
DescriptionOptional help text shown under the field when you edit a plan.
TypeText, Number, Boolean (a checkbox), or Select. A Select field lets you list the allowed values.
PrivateKeeps the field's values out of anything delivered to visitors. See Public and private.

Only organization admins can create, edit, or delete plan fields.

Public and private​

A public field is available wherever plan details are shared with visitors, such as a template that lists the plans in an offer. Use public fields for details visitors should see, like "Includes 5 seats".

A private field is for your team only. Its values are never delivered to visitors, so it is the right choice for internal details like a cost code or an accounting reference. A private field still appears when you edit a plan.

Fill in values on a plan​

Open any plan from Entitlements → Plans. The Custom fields card lists every field you have defined. Fill in the ones that apply and select Save Changes. Leave a field empty if it does not apply to that plan.

If you have not defined any fields yet, the card links to Plan Fields so you can set them up.

Changing and deleting fields​

You can change a field's name, description, type, and privacy at any time. If you change the type of a field, review the plans that already have a value for it, since an old value may no longer fit.

Deleting a field removes it from the plan form. Values already saved on plans are discarded the next time you save that plan.