Skip to content

PlanTrait ​

Type
Trait
Namespace
craft\commerce\base
Implemented by
craft\commerce\base\Plan, craft\commerce\models\subscriptions\DummyPlan
Since
2.0

Plan trait

View source

Public Properties ​

PropertyDescription
dateArchivedDateTime, null – When the plan was archived
enabledboolean – Whether the plan is enabled on site
gatewayIdinteger, null – The gateway ID.
handlestring, null – Plan handle
idinteger, null – Plan ID
isArchivedboolean – Whether the plan is archived
namestring, null – Plan name
planDatastring, null – Gateway response
planInformationIdinteger, null – ID of the entry containing plan information
referencestring, null – Plan reference on the gateway
sortOrderinteger, null – Sort order
uidstring, null – Plan uid

dateArchived ​

Type
DateTime, null
Default value
null

When the plan was archived

View source

enabled ​

Type
boolean
Default value
false

Whether the plan is enabled on site

View source

gatewayId ​

Type
integer, null
Default value
null

The gateway ID.

View source

handle ​

Type
string, null
Default value
null

Plan handle

View source

id ​

Type
integer, null
Default value
null

Plan ID

View source

isArchived ​

Type
boolean
Default value
false

Whether the plan is archived

View source

name ​

Type
string, null
Default value
null

Plan name

View source

planData ​

Type
string, null
Default value
null

Gateway response

View source

planInformationId ​

Type
integer, null
Default value
null

ID of the entry containing plan information

View source

reference ​

Type
string, null
Default value
null

Plan reference on the gateway

View source

sortOrder ​

Type
integer, null
Default value
null

Sort order

View source

uid ​

Type
string, null
Default value
null

Plan uid

View source