API Documentation
\

\Simplify_Coupon

Base class for all domain objects.

Summary

Methods
Properties
Constants
createCoupon()
deleteCoupon()
listCoupon()
findCoupon()
updateCoupon()
setAll()
getProperties()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$properties
N/A

Properties

$properties

$properties

Methods

createCoupon()

createCoupon(array $hash, mixed $authentication) : \Coupon

Creates an Simplify_Coupon object

Parameters

array $hash

a map of parameters; valid keys are:

amountOff
Amount off of the price of the product in the smallest units of the currency of the merchant. While this field is optional, you must provide either amountOff or percentOff for a coupon. Example: 100 = $1.00 [min value: 1]
couponCode
Code that identifies the coupon to be used. [max length: 25, min length: 3] required
description
A brief section that describes the coupon. [max length: 1024]
durationInMonths
DEPRECATED - Duration in months that the coupon will be applied after it has first been selected. [min value: 1, max value: 9999]
endDate
Last date of the coupon in UTC millis that the coupon can be applied to a subscription. This ends at 23:59:59 of the merchant timezone.
maxRedemptions
Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. [min value: 1, max value: 10000]
numTimesApplied
The number of times a coupon will be applied on a customer's subscription. [min value: 1, max value: 9999]
percentOff
Percentage off of the price of the product. While this field is optional, you must provide either amountOff or percentOff for a coupon. The percent off is a whole number. [min value: 1, max value: 100]
startDate
First date of the coupon in UTC millis that the coupon can be applied to a subscription. This starts at midnight of the merchant timezone. required
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.<i/>

Returns

\Coupon —

a Coupon object.

deleteCoupon()

deleteCoupon(mixed $authentication)

Deletes an Simplify_Coupon object.

Parameters

mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

listCoupon()

listCoupon( $criteria, mixed $authentication) : \ResourceList

Retrieve Simplify_Coupon objects.

Parameters

$criteria
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\ResourceList —

a ResourceList object that holds the list of Coupon objects and the total number of Coupon objects available for the given criteria.

findCoupon()

findCoupon( $id, mixed $authentication) : \Coupon

Retrieve a Simplify_Coupon object from the API

Parameters

$id
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\Coupon —

a Coupon object

updateCoupon()

updateCoupon(mixed $authentication) : \Coupon

Updates an Simplify_Coupon object.

The properties that can be updated:

endDate
The ending date in UTC millis for the coupon. This must be after the starting date of the coupon.
maxRedemptions
Maximum number of redemptions allowed for the coupon. A redemption is defined as when the coupon is applied to the subscription for the first time. [min value: 1]

Parameters

mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\Coupon —

a Coupon object.

setAll()

setAll(mixed $hash)

Updates the object's properties with the values in the specified map.

Parameters

mixed $hash

array Map of values to set.

getProperties()

getProperties() : array

Returns the object's properties as a map.

Returns

array —

map of properties.