PlentyMarketplace

Contracts

SubscriptionInformationServiceContract

Get information about plugin subscriptions. Only suitable for subscription plugins.

Namespace

Plenty\Modules\PlentyMarketplace\Contracts

Methods

public isPaid(string $pluginName):bool

Takes the Name of a subscription plugin and returns true if the subscription has been paid for in the current payment period on the current system.

Parameters
string $pluginName The plugin name. Must be exactly as provided in the plugin.json.
public getSubscriptionInfo(string $pluginName):SubscriptionOrderInformation

Takes the Name of a subscription plugin and returns information about the subscription.

Parameters
string $pluginName The plugin name. Must be exactly as provided in the plugin.json.

Models

SubscriptionChildOrderInformation

Eloquent model representing a SubscriptionChildOrderInformation.

Namespace

Plenty\Modules\PlentyMarketplace\Models

Properties

Type Name Description
string paymentStatus
array paymentInformation

Methods

public toArray()

Returns this model as an array.

SubscriptionOrderInformation

Eloquent model representing a SubscriptionOrderInformation.

Namespace

Plenty\Modules\PlentyMarketplace\Models

Properties

Type Name Description
bool isPaid
string intervalType
string intervalValue
string startDate
string subscriptionLastRun
string subscriptionNextRun
array childOrders

Methods

public toArray()

Returns this model as an array.

SubscriptionChildPaymentInformation

Eloquent model representing a SubscriptionChildPaymentInformation.

Namespace

Plenty\Modules\PlentyMarketplace\Models

Properties

Type Name Description
float amount The amount of the payment
int status The status of the payment
int unaccountable An unassigned payment. Unassigned payments have the value 1.
string currency The currency of the payment in ISO 4217 code.
string receivedAt The time the payment was received
string importedAt The time the payment was imported

Methods

public toArray()

Returns this model as an array.