Plan Object
Plan ID.
Plan name.
Plan description.
What is included with this plan (e.g., 1 weekly entrance to a specific class).
Plan price, payment schedule, and expiration.
Whether the plan is public (visible to site visitors and members).
Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.
Whether the plan is marked as primary.
Whether the plan has any orders (including pending and unpaid orders).
Date plan was created.
Date plan was last updated.
URL-friendly version of plan name. Unique across all plans in the same site.
Number of times the same buyer can purchase the plan. Currently limited to support:
- Empty value or a value of 0, meaning no limitation.
- Value of 1, meaning limited to one purchase per buyer.
Whether the buyer can start the plan at a later date. Defaults to false.
Whether the buyer is allowed to cancel their plan. Defaults to false.
Any terms and conditions that apply to the plan. This information will be displayed during checkout.
ID of the form associated with the plan at checkout.
Learn more about forms.