SubscriptionResponseInterface

Type
Interface
Namespace
craft\commerce\base
Implemented by
craft\commerce\models\responses\DummySubscriptionResponse
Since
2.0

This interface class functions that a Subscription response needs to implement

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.

getData()

Returns the response data.

View source

Returns

mixed

Signature

public abstract mixed getData ( )

getNextPaymentDate()

Returns the time of next payment.

View source

Returns

DateTime

Signature

public abstract DateTime getNextPaymentDate ( )

getReference()

Returns the subscription reference.

View source

Returns

string

Signature

public abstract string getReference ( )

getTrialDays()

Returns the number of trial days on the subscription.

View source

Returns

integer

Signature

public abstract integer getTrialDays ( )

isCanceled()

Returns whether the subscription is canceled.

View source

Returns

boolean

Signature

public abstract boolean isCanceled ( )

isScheduledForCancellation()

Returns whether the subscription is scheduled to be canceled.

View source

Returns

boolean

Signature

public abstract boolean isScheduledForCancellation ( )