API Documentation
\

\Simplify_Subscription

Base class for all domain objects.

Summary

Methods
Properties
Constants
createSubscription()
deleteSubscription()
listSubscription()
findSubscription()
updateSubscription()
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

createSubscription()

createSubscription(array $hash, mixed $authentication) : \Subscription

Creates an Simplify_Subscription object

Parameters

array $hash

a map of parameters; valid keys are:

amount
Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00
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
coupon
Coupon ID associated with the subscription
currency
Currency code (ISO-4217). Must match the currency associated with your account.
currentPeriodEnd
End date of subscription's current period
currentPeriodStart
Start date of subscription's current period
customer
Customer that is enrolling in the subscription.
frequency
Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".
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.
name
Name describing subscription [max length: 50]
plan
The ID of the plan that should be used for the subscription.
quantity
Quantity of the plan for the subscription. [min value: 1]
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.
source
Source of where subscription was created
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

\Subscription —

a Subscription object.

deleteSubscription()

deleteSubscription(mixed $authentication)

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

listSubscription()

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

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

findSubscription()

findSubscription( $id, mixed $authentication) : \Subscription

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

\Subscription —

a Subscription object

updateSubscription()

updateSubscription(mixed $authentication) : \Subscription

Updates an Simplify_Subscription object.

The properties that can be updated:

amount
Amount of the payment in the smallest unit of your currency. Example: 100 = $1.00
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
coupon
Coupon being assigned to this subscription
currency
Currency code (ISO-4217). Must match the currency associated with your account.
currentPeriodEnd
End date of subscription's current period
currentPeriodStart
Start date of subscription's current period
frequency
Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY".
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]
name
Name describing subscription
plan
Plan that should be used for the subscription.
prorate
Whether to prorate existing subscription. [default: true] required
quantity
Quantity of the plan for the subscription. [min value: 1]
renewalReminderLeadDays
If set, how many days before the next billing cycle that a renewal reminder is sent to the customer. If null or 0, no emails are sent. Minimum value is 7 if set.

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

\Subscription —

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