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 – When the plan was archived
$enabledboolean – Whether the plan is enabled on site
$gatewayIdinteger – The gateway ID.
$handlestring – Plan handle
$idinteger – Plan ID
$isArchivedboolean – Whether the plan is archived
$namestring – Plan name
$planDatastring – Gateway response
$planInformationIdinteger – ID of the entry containing plan information
$referencestring – Plan reference on the gateway
$uidstring – Plan uid

$dateArchived

Type
DateTime

When the plan was archived

View source

Signature

public DateTime $dateArchived = null

$enabled

Type
boolean

Whether the plan is enabled on site

View source

Signature

public boolean $enabled = null

$gatewayId

Type
integer

The gateway ID.

View source

Signature

public integer $gatewayId = null

$handle

Type
string

Plan handle

View source

Signature

public string $handle = null

$id

Signature

public integer $id = null

$isArchived

Type
boolean

Whether the plan is archived

View source

Signature

public boolean $isArchived = null

$name

Type
string

Plan name

View source

Signature

public string $name = null

$planData

Type
string
Access
Read-only

Gateway response

View source

Signature

public mixed getPlanData ( )

$planInformationId

Type
integer

ID of the entry containing plan information

View source

Signature

public integer $planInformationId = null

$reference

Type
string

Plan reference on the gateway

View source

Signature

public string $reference = null

$uid

Type
string

Plan uid

View source

Signature

public string $uid = null