Class Subscription

Describes a recurring product

mcfedr\Paypal\Products\Product

Extended by

mcfedr\Paypal\Products\Subscription

Namespace: mcfedr\Paypal\Products
Located at mcfedr/Paypal/Products/Subscription.php

Methods summary
`public`	# `__construct( array $vars = null )` Get a product from $vars Get a product from $vars Parameters `$vars` `array` $vars Overrides `mcfedr\Paypal\Products\Product::__construct()`
`public`	# `setParams( array & $params, string $suffix = '' )` Sets up the array with paypal vars for $product Sets up the array with paypal vars for $product Parameters `$params` `array` $params `$suffix` `string` $suffix Overrides `mcfedr\Paypal\Products\Product::setParams()`

Constants summary
`string`	`DAYS`	`'D'`	#
`string`	`WEEKS`	`'W'`	#
`string`	`MONTHS`	`'M'`	#
`string`	`YEARS`	`'Y'`	#

Properties summary
`public integer`	`$duration`		# The length of the subscription The length of the subscription
`public string`	`$units`		# Unit used for `mcfedr\Paypal\Products\Subscription::$duration` Unit used for `mcfedr\Paypal\Products\Subscription::$duration` See `mcfedr\Paypal\Products\Subscription::DAYS` `mcfedr\Paypal\Products\Subscription::WEEKS` `mcfedr\Paypal\Products\Subscription::MONTHS` `mcfedr\Paypal\Products\Subscription::YEARS`
`public float`	`$trialAmount`		# Trial price of the product Trial price of the product
`public integer`	`$trialDuration`		# The length of the trial subscription The length of the trial subscription
`public string`	`$trialUnits`		# Unit used for `mcfedr\Paypal\Products\Subscription::$trialDuration` Unit used for `mcfedr\Paypal\Products\Subscription::$trialDuration` See `mcfedr\Paypal\Products\Subscription::DAYS` `mcfedr\Paypal\Products\Subscription::WEEKS` `mcfedr\Paypal\Products\Subscription::MONTHS` `mcfedr\Paypal\Products\Subscription::YEARS`
`public boolean`	`$recurring`	`true`	# Is this a recurring subscription Is this a recurring subscription
`public integer`	`$recurLimit`		# Number of times to recur Number of times to recur
`public boolean`	`$reattempt`	`true`	# Whether to reattempt collection of payment when it fails Whether to reattempt collection of payment when it fails
`public boolean`	`$allowNew`	`true`	# Can the user signup for a new subscription with this button Can the user signup for a new subscription with this button
`public boolean`	`$allowModify`	`false`	# Can the user modify their existing subscription with this button Can the user modify their existing subscription with this button
`public boolean`	`$generateUsernameAndPassword`	`false`	# Let paypal generate a username and password Let paypal generate a username and password
`public string`	`$subscriptionId`		# The paypal id for this subscription Set for notification The paypal id for this subscription Set for notification
`public string`	`$username`		# The generated username The generated username
`public string`	`$password`		# The generated password The generated password

Properties inherited from mcfedr\Paypal\Products\Product
`$amount, $fee, $id, $name`