API Documentation
\

\Simplify_Plan

Base class for all domain objects.

Summary

Methods
Properties
Constants
createPlan()
deletePlan()
listPlan()
findPlan()
updatePlan()
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

createPlan()

createPlan(array $hash, mixed $authentication) : \Plan

Creates an Simplify_Plan object

Parameters

array $hash

a map of parameters; valid keys are:

amount
Amount of payment for the plan in the smallest unit of your currency. Example: 100 = $1.00 required
billingCycle
How the plan is billed to the customer. Values must be AUTO (indefinitely until the customer cancels) or FIXED (a fixed number of billing cycles). [default: AUTO]
billingCycleLimit
The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4
currency
Currency code (ISO-4217) for the plan. Must match the currency associated with your account. [default: USD] required
frequency
Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY". [default: MONTHLY] required
frequencyPeriod
Period of frequency of payment for the plan. Example: if the frequency is weekly, and periodFrequency is 2, then the subscription is billed bi-weekly. [min value: 1, default: 1] required
name
Name of the plan [max length: 50, min length: 2] required
renewalReminderLeadDays
If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null, then no emails are sent. Minimum value is 7 if set.
trialPeriod
Plan free trial period selection. Must be Days, Weeks, or Month [default: NONE] required
trialPeriodQuantity
Quantity of the trial period. Must be greater than 0 and a whole number. [min value: 1]
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

\Plan —

a Plan object.

deletePlan()

deletePlan(mixed $authentication)

Deletes an Simplify_Plan 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.

listPlan()

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

Retrieve Simplify_Plan 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 Plan objects and the total number of Plan objects available for the given criteria.

findPlan()

findPlan( $id, mixed $authentication) : \Plan

Retrieve a Simplify_Plan 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

\Plan —

a Plan object

updatePlan()

updatePlan(mixed $authentication) : \Plan

Updates an Simplify_Plan object.

The properties that can be updated:

name
Name of the plan. [min length: 2] required

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

\Plan —

a Plan 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.