com.simplify.payments.domain

Class Plan

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,java.lang.Object>

com.simplify.payments.PaymentsMap

com.simplify.payments.PaymentsObject

com.simplify.payments.domain.Plan

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class Plan
extends PaymentsObject

A Plan object.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields inherited from class com.simplify.payments.PaymentsObject

authentication

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Plan()
protected	Plan(java.util.Map m)
protected	Plan(PaymentsObject o)

Method Summary

Modifier and Type	Method and Description
static Plan	create(Authentication auth, java.util.Map map) Creates an Plan object
static Plan	create(java.util.Map map) Creates an Plan object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static Plan	create(java.lang.String publicKey, java.lang.String privateKey, java.util.Map map) Deprecated. As of release 1.1, replaced by create(Authentication, Map)
Plan	delete() Deletes an Plan object.
static Plan	find(Authentication auth, java.lang.String id) Retrieve a Plan object.
static Plan	find(java.lang.String id) Retrieve a Plan object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static Plan	find(java.lang.String publicKey, java.lang.String privateKey, java.lang.String id) Deprecated. As of release 1.1, replaced by find(Authentication, String)
protected java.lang.String	getObjectType()
static ResourceList<Plan>	list() Retrieve Plan objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<Plan>	list(Authentication auth) Retrieve Plan objects using the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<Plan>	list(Authentication auth, java.util.Map criteria) Retrieve Plan objects using the specified criteria.
static ResourceList<Plan>	list(java.util.Map criteria) Retrieve Plan objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static ResourceList<Plan>	list(java.lang.String publicKey, java.lang.String privateKey) Deprecated. As of release 1.1, replaced by list(Authentication)
static ResourceList<Plan>	list(java.lang.String publicKey, java.lang.String privateKey, java.util.Map criteria) Deprecated. As of release 1.1, replaced by list(Authentication, Map)
Plan	update() Updates an Plan object.

Methods inherited from class com.simplify.payments.PaymentsObject

createObject, deleteObject, findObject, getAuthentication, listObjects, listObjects, updateObject

Methods inherited from class com.simplify.payments.PaymentsMap

containsKey, get, normalize, put, remove, set

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Constructor Detail

Plan

protected Plan()

Plan

protected Plan(PaymentsObject o)

Plan

protected Plan(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

public static Plan create(java.util.Map map)
                   throws ApiCommunicationException,
                          AuthenticationException,
                          InvalidRequestException,
                          NotAllowedException,
                          SystemException

Creates an Plan object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

map - a map of parameters, valid keys and types:

java.lang.Long amount

Amount of payment for the plan in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.String 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]

java.lang.Integer billingCycleLimit

The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4

java.lang.String currency

Currency code (ISO-4217) for the plan. Must match the currency associated with your account. [default: USD] required

java.lang.String frequency

Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY". [default: MONTHLY] required

java.lang.Integer 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

java.lang.String name

Name of the plan [max length: 50, min length: 2] required

java.lang.Integer 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.

java.lang.String trialPeriod

Plan free trial period selection. Must be Days, Weeks, or Month [default: NONE] required

java.lang.Integer trialPeriodQuantity

Quantity of the trial period. Must be greater than 0 and a whole number. [min value: 1]

Returns:

a Plan object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static Plan create(java.lang.String publicKey,
                                      java.lang.String privateKey,
                                      java.util.Map map)
                               throws ApiCommunicationException,
                                      AuthenticationException,
                                      InvalidRequestException,
                                      NotAllowedException,
                                      SystemException

Deprecated. As of release 1.1, replaced by create(Authentication, Map)

Creates an Plan object

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

java.lang.Long amount

Amount of payment for the plan in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.String 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]

java.lang.Integer billingCycleLimit

The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4

java.lang.String currency

Currency code (ISO-4217) for the plan. Must match the currency associated with your account. [default: USD] required

java.lang.String frequency

Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY". [default: MONTHLY] required

java.lang.Integer 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

java.lang.String name

Name of the plan [max length: 50, min length: 2] required

java.lang.Integer 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.

java.lang.String trialPeriod

Plan free trial period selection. Must be Days, Weeks, or Month [default: NONE] required

java.lang.Integer trialPeriodQuantity

Quantity of the trial period. Must be greater than 0 and a whole number. [min value: 1]

Returns:

a Plan object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

public static Plan create(Authentication auth,
                          java.util.Map map)
                   throws ApiCommunicationException,
                          AuthenticationException,
                          InvalidRequestException,
                          NotAllowedException,
                          SystemException

Creates an Plan object

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

java.lang.Long amount

Amount of payment for the plan in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.String 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]

java.lang.Integer billingCycleLimit

The number of fixed billing cycles for a plan. Only used if the billingCycle parameter is set to FIXED. Example: 4

java.lang.String currency

Currency code (ISO-4217) for the plan. Must match the currency associated with your account. [default: USD] required

java.lang.String frequency

Frequency of payment for the plan. Used in conjunction with frequencyPeriod. Valid values are "DAILY", "WEEKLY", "MONTHLY" and "YEARLY". [default: MONTHLY] required

java.lang.Integer 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

java.lang.String name

Name of the plan [max length: 50, min length: 2] required

java.lang.Integer 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.

java.lang.String trialPeriod

Plan free trial period selection. Must be Days, Weeks, or Month [default: NONE] required

java.lang.Integer trialPeriodQuantity

Quantity of the trial period. Must be greater than 0 and a whole number. [min value: 1]

Returns:

a Plan object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

delete

public Plan delete()
            throws ApiCommunicationException,
                   AuthenticationException,
                   InvalidRequestException,
                   ObjectNotFoundException,
                   NotAllowedException,
                   SystemException

Deletes an Plan object.

Returns:

a Plan object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

list

public static ResourceList<Plan> list()
                               throws ApiCommunicationException,
                                      AuthenticationException,
                                      InvalidRequestException,
                                      NotAllowedException,
                                      SystemException

Retrieve Plan objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).

Returns:

a ResourceList object which holds the list of Plan objects and the total number of Plan objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

@Deprecated
public static ResourceList<Plan> list(java.lang.String publicKey,
                                                  java.lang.String privateKey)
                                           throws ApiCommunicationException,
                                                  AuthenticationException,
                                                  InvalidRequestException,
                                                  NotAllowedException,
                                                  SystemException

Deprecated. As of release 1.1, replaced by list(Authentication)

Retrieve Plan objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of Plan objects and the total number of Plan objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Plan> list(Authentication auth)
                               throws ApiCommunicationException,
                                      AuthenticationException,
                                      InvalidRequestException,
                                      NotAllowedException,
                                      SystemException

Retrieve Plan objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

Returns:

a ResourceList object which holds the list of Plan objects and the total number of Plan objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Plan> list(java.util.Map criteria)
                               throws ApiCommunicationException,
                                      AuthenticationException,
                                      InvalidRequestException,
                                      NotAllowedException,
                                      SystemException

Retrieve Plan objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the plan Id
filter.text	Filter by the name of the plan
filter.frequency	Filter by the frequency of the plan
filter.amountMin & filter.amountMax	The filter amountMin must be used with amountMax to find plans with plan values between the min and max figures
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis
filter.q	You can use this to filter by the Id, the name or the amount of the plan

^*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map sorting

Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated amount frequency name id .

Returns:

a ResourceList object which holds the list of Plan objects and the total number of Plan objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Plan> list(java.lang.String publicKey,
                                      java.lang.String privateKey,
                                      java.util.Map criteria)
                               throws ApiCommunicationException,
                                      AuthenticationException,
                                      InvalidRequestException,
                                      NotAllowedException,
                                      SystemException

Deprecated. As of release 1.1, replaced by list(Authentication, Map)

Retrieve Plan objects using the specified criteria.

Parameters:

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the plan Id
filter.text	Filter by the name of the plan
filter.frequency	Filter by the frequency of the plan
filter.amountMin & filter.amountMax	The filter amountMin must be used with amountMax to find plans with plan values between the min and max figures
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis
filter.q	You can use this to filter by the Id, the name or the amount of the plan

^*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map sorting

Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated amount frequency name id .

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of Plan objects and the total number of Plan objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Plan> list(Authentication auth,
                                      java.util.Map criteria)
                               throws ApiCommunicationException,
                                      AuthenticationException,
                                      InvalidRequestException,
                                      NotAllowedException,
                                      SystemException

Retrieve Plan objects using the specified criteria.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

criteria - a map of parameters; valid keys and types are:

java.util.Map filter

filter.id	Filter by the plan Id
filter.text	Filter by the name of the plan
filter.frequency	Filter by the frequency of the plan
filter.amountMin & filter.amountMax	The filter amountMin must be used with amountMax to find plans with plan values between the min and max figures
filter.dateCreatedMin*	Filter by the minimum created date you are searching for - Date in UTC millis
filter.dateCreatedMax*	Filter by the maximum created date you are searching for - Date in UTC millis
filter.q	You can use this to filter by the Id, the name or the amount of the plan

^*Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

java.lang.Integer max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

java.lang.Integer offset

Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0]

java.util.Map sorting

Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc for ascending or desc for descending). Sortable properties are: dateCreated amount frequency name id .

Returns:

a ResourceList object which holds the list of Plan objects and the total number of Plan objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

find

public static Plan find(java.lang.String id)
                 throws ApiCommunicationException,
                        AuthenticationException,
                        InvalidRequestException,
                        ObjectNotFoundException,
                        NotAllowedException,
                        SystemException

Retrieve a Plan object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

id - the id of the Plan object to retrieve

Returns:

a Plan object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

@Deprecated
public static Plan find(java.lang.String publicKey,
                                    java.lang.String privateKey,
                                    java.lang.String id)
                             throws ApiCommunicationException,
                                    AuthenticationException,
                                    InvalidRequestException,
                                    ObjectNotFoundException,
                                    NotAllowedException,
                                    SystemException

Deprecated. As of release 1.1, replaced by find(Authentication, String)

Retrieve a Plan object.

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

id - the id of the Plan object to retrieve

Returns:

a Plan object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

public static Plan find(Authentication auth,
                        java.lang.String id)
                 throws ApiCommunicationException,
                        AuthenticationException,
                        InvalidRequestException,
                        ObjectNotFoundException,
                        NotAllowedException,
                        SystemException

Retrieve a Plan object.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

id - the id of the Plan object to retrieve

Returns:

a Plan object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

update

public Plan update()
            throws ApiCommunicationException,
                   AuthenticationException,
                   InvalidRequestException,
                   ObjectNotFoundException,
                   NotAllowedException,
                   SystemException

Updates an Plan object. The properties that can be updated:

• name (required)

Returns:

a Plan object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException