Skip to content

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.
isInactive()Whether the subscription is unpaid.
isScheduledForCancellation()Returns whether the subscription is scheduled to be canceled.

getData() ​

Returns the response data.

View source

Returns ​

mixed

getNextPaymentDate() ​

Returns the time of next payment.

View source

getReference() ​

Returns the subscription reference.

View source

getTrialDays() ​

Returns the number of trial days on the subscription.

View source

isCanceled() ​

Returns whether the subscription is canceled.

View source

isInactive() ​

Whether the subscription is unpaid.

View source

isScheduledForCancellation() ​

Returns whether the subscription is scheduled to be canceled.

View source