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 (opens new window)

# Public Properties

Property Description
dateArchived DateTime (opens new window) – When the plan was archived
enabled boolean (opens new window) – Whether the plan is enabled on site
gatewayId integer (opens new window) – The gateway ID.
handle string (opens new window) – Plan handle
id integer (opens new window) – Plan ID
isArchived boolean (opens new window) – Whether the plan is archived
name string (opens new window) – Plan name
planData string (opens new window) – Gateway response
planInformationId integer (opens new window) – ID of the entry containing plan information
reference string (opens new window) – Plan reference on the gateway
sortOrder integer (opens new window) – Sort order
uid string (opens new window) – Plan uid

# dateArchived

Type
DateTime (opens new window)
Default value
null

When the plan was archived

View source (opens new window)

# enabled

Type
boolean (opens new window)
Default value
null

Whether the plan is enabled on site

View source (opens new window)

# gatewayId

Type
integer (opens new window)
Default value
null

The gateway ID.

View source (opens new window)

# handle

Type
string (opens new window)
Default value
null

Plan handle

View source (opens new window)

# id

Type
integer (opens new window)
Default value
null

Plan ID

View source (opens new window)

# isArchived

Type
boolean (opens new window)
Default value
null

Whether the plan is archived

View source (opens new window)

# name

Type
string (opens new window)
Default value
null

Plan name

View source (opens new window)

# planData

Type
string (opens new window)
Default value
null

Gateway response

View source (opens new window)

# planInformationId

Type
integer (opens new window)
Default value
null

ID of the entry containing plan information

View source (opens new window)

# reference

Type
string (opens new window)
Default value
null

Plan reference on the gateway

View source (opens new window)

# sortOrder

Type
integer (opens new window)
Default value
null

Sort order

View source (opens new window)

# uid

Type
string (opens new window)
Default value
null

Plan uid

View source (opens new window)