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

Method Description
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

Returns

DateTime

# getReference()

Returns the subscription reference.

View source

Returns

string

# getTrialDays()

Returns the number of trial days on the subscription.

View source

Returns

integer

# isCanceled()

Returns whether the subscription is canceled.

View source

Returns

boolean

# isInactive()

Whether the subscription is unpaid.

View source

Returns

boolean

# isScheduledForCancellation()

Returns whether the subscription is scheduled to be canceled.

View source

Returns

boolean