Plan Object


Deprecated

This object is deprecated and was replaced with Plan Object.

Information about the pricing plan.

Properties
allowFutureStartDateboolean

Whether the buyer can start the plan at a later date. Defaults to false.


archivedbooleanRead-only

Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.


buyerCanCancelboolean

Whether the buyer is allowed to cancel their plan. Defaults to false. If false, calling Request Cancellation returns an error.


createdDatestringRead-onlyformat date-time

Date plan was created.


descriptionstringmaxLength 450

Plan description.


formIdstringformat GUID

ID of the form associated with the plan at checkout.

Learn more about forms.


hasOrdersbooleanRead-only

Whether the plan has any orders (including pending and unpaid orders).


idstringRead-onlyformat GUID

Plan ID.


maxPurchasesPerBuyerintegerminimum 0maximum 1format int32

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 1 purchase per buyer.

namestringminLength 1maxLength 50

Plan name.


perksPerks

List of text strings that promote what is included with this plan. For example, "Plenty of parking" or "Free gift on your birthday."


pricingPricing

Plan price, payment schedule, and expiration.


primarybooleanRead-only

Whether the plan is marked as primary.


publicboolean

Whether the plan is public (visible to site visitors and members).


slugstringRead-onlyminLength 1format URL_SLUG

URL-friendly version of plan name. Unique across all plans in the same site.


termsAndConditionsstringmaxLength 3000

Any terms and conditions that apply to the plan. This information is displayed during checkout.


updatedDatestringRead-onlyformat date-time

Date plan was last updated.

Did this help?