DummySubscriptionResponse

Type
Class
Namespace
craft\commerce\models\responses
Inherits
craft\commerce\models\responses\DummySubscriptionResponse
Implements
craft\commerce\base\SubscriptionResponseInterface
Since
2.0

This is a dummy gateway request response.

View source

Public Methods

MethodDescription
getData()Returns the response data.
getNextPaymentDate()Returns the time of next payment.
getReference()Returns the subscription reference.
getTrialDays()Returns the number of trial days on the subscription.
isCanceled()Returns whether the subscription is canceled.
isScheduledForCancellation()Returns whether the subscription is scheduled to be canceled.
setIsCanceled()
setTrialDays()

getData()

Returns the response data.

View source

Returns

mixed

Signature

public mixed getData ( )

getNextPaymentDate()

Returns the time of next payment.

View source

Returns

DateTime

Signature

public DateTime getNextPaymentDate ( )

getReference()

Returns the subscription reference.

View source

Returns

string

Signature

public string getReference ( )

getTrialDays()

Returns the number of trial days on the subscription.

View source

Returns

integer

Signature

public integer getTrialDays ( )

isCanceled()

Returns whether the subscription is canceled.

View source

Returns

boolean

Signature

public boolean isCanceled ( )

isScheduledForCancellation()

Returns whether the subscription is scheduled to be canceled.

View source

Returns

boolean

Signature

public boolean isScheduledForCancellation ( )

setIsCanceled()

View source

Arguments

  • $isCanceled

Signature

public void setIsCanceled ( \craft\commerce\models\responses\bool $isCanceled )

setTrialDays()

View source

Arguments

  • $trialDays

Signature

public void setTrialDays ( \craft\commerce\models\responses\int $trialDays )