craft\commerce
craft\commerce\adjusters
craft\commerce\base
craft\commerce\behaviors
craft\commerce\console
craft\commerce\console\controllers
craft\commerce\controllers
craft\commerce\db
craft\commerce\elements
craft\commerce\elements\actions
craft\commerce\elements\db
craft\commerce\elements\traits
craft\commerce\engines
craft\commerce\errors
craft\commerce\events
craft\commerce\exports
craft\commerce\fieldlayoutelements
craft\commerce\fields
craft\commerce\gateways
craft\commerce\gql\arguments\elements
craft\commerce\gql\interfaces\elements
craft\commerce\gql\queries
craft\commerce\gql\resolvers\elements
craft\commerce\gql\types
craft\commerce\gql\types\elements
craft\commerce\gql\types\generators
craft\commerce\gql\types\input
craft\commerce\helpers
craft\commerce\migrations
craft\commerce\models
craft\commerce\models\payments
craft\commerce\models\responses
craft\commerce\models\subscriptions
craft\commerce\plugin
craft\commerce\queue\jobs
craft\commerce\records
craft\commerce\services
craft\commerce\stats
craft\commerce\test\fixtures\elements
craft\commerce\test\mockclasses
craft\commerce\web\assets\chartjs
craft\commerce\web\assets\commercecp
craft\commerce\web\assets\commerceui
craft\commerce\web\assets\deepmerge
craft\commerce\web\assets\editproduct
craft\commerce\web\assets\orderswidget
craft\commerce\web\assets\productindex
craft\commerce\web\assets\statwidgets
craft\commerce\web\assets\variantmatrix
craft\commerce\web\panel
craft\commerce\web\twig
craft\commerce\widgets

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 (opens new window)

# 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 (opens new window)

Returns

mixed

# `getNextPaymentDate()`

Returns the time of next payment.

View source (opens new window)

Returns

DateTime (opens new window)

# `getReference()`

Returns the subscription reference.

View source (opens new window)

Returns

string (opens new window)

# `getTrialDays()`

Returns the number of trial days on the subscription.

View source (opens new window)

Returns

integer (opens new window)

# `isCanceled()`

Returns whether the subscription is canceled.

View source (opens new window)

Returns

boolean (opens new window)

# `isInactive()`

Whether the subscription is unpaid.

View source (opens new window)

Returns

boolean (opens new window)

# `isScheduledForCancellation()`

Returns whether the subscription is scheduled to be canceled.

View source (opens new window)

Returns

boolean (opens new window)

← SubscriptionGatewayInterface TaxEngineInterface →