For the complete documentation index, see llms.txt. This page is also available as Markdown.

Step Roles

A step's Role declares what the step is for — and, crucially, which internal commerce actions the step must perform. When a step has a role, the role brings a mandated set of required (locked) commerce actions with it, so PeakCommerce's own writes always run for that kind of step. Some roles also change how the step runs.

Role
What it does

(none)

Default runner behavior; no mandated actions.

Pricing

Skips the ?p= prefill requirement, so custom pricing pages don't trip the prefill guardrail.

Signup

Marks an account-creation / lead-capture step and mandates the internal writes that create the organization and contact. Signup steps also unlock the signup form field editor, which controls the fields the form collects and how each validates.

Payment

Marks a payment / checkout step and mandates the internal writes that record the order and keep the contact and organization current.

Content

Marks an informational step.

Set a step's role when editing it on the Steps tab. The required actions a role brings appear locked (🔒) in the step's Commerce actions list — you can reorder them but not remove them. See Commerce Actions.

Last updated

Was this helpful?