com.simplify.payments.domain

Class Subscription

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

All Implemented Interfaces:

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

public class Subscription
extends PaymentsObject

A Subscription 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	Subscription()
protected	Subscription(java.util.Map m)
protected	Subscription(PaymentsObject o)

Method Summary

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

Subscription

protected Subscription()

Subscription

protected Subscription(PaymentsObject o)

Subscription

protected Subscription(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

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

Creates an Subscription 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 the payment in the smallest unit of your currency. Example: 100 = $1.00

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 coupon

Coupon ID associated with the subscription

java.lang.String currency

Currency code (ISO-4217). Must match the currency associated with your account.

java.lang.Long currentPeriodEnd

End date of subscription's current period

java.lang.Long currentPeriodStart

Start date of subscription's current period

java.lang.String customer

Customer that is enrolling in the subscription.

java.lang.String frequency

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

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.

java.lang.String name

Name describing subscription [max length: 50]

java.lang.String plan

The ID of the plan that should be used for the subscription.

java.lang.Integer quantity

Quantity of the plan for the subscription. [min value: 1]

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 source

Source of where subscription was created

Returns:

a Subscription object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static Subscription 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 Subscription 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 the payment in the smallest unit of your currency. Example: 100 = $1.00

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 coupon

Coupon ID associated with the subscription

java.lang.String currency

Currency code (ISO-4217). Must match the currency associated with your account.

java.lang.Long currentPeriodEnd

End date of subscription's current period

java.lang.Long currentPeriodStart

Start date of subscription's current period

java.lang.String customer

Customer that is enrolling in the subscription.

java.lang.String frequency

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

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.

java.lang.String name

Name describing subscription [max length: 50]

java.lang.String plan

The ID of the plan that should be used for the subscription.

java.lang.Integer quantity

Quantity of the plan for the subscription. [min value: 1]

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 source

Source of where subscription was created

Returns:

a Subscription object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

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

Creates an Subscription 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 the payment in the smallest unit of your currency. Example: 100 = $1.00

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 coupon

Coupon ID associated with the subscription

java.lang.String currency

Currency code (ISO-4217). Must match the currency associated with your account.

java.lang.Long currentPeriodEnd

End date of subscription's current period

java.lang.Long currentPeriodStart

Start date of subscription's current period

java.lang.String customer

Customer that is enrolling in the subscription.

java.lang.String frequency

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

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.

java.lang.String name

Name describing subscription [max length: 50]

java.lang.String plan

The ID of the plan that should be used for the subscription.

java.lang.Integer quantity

Quantity of the plan for the subscription. [min value: 1]

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 source

Source of where subscription was created

Returns:

a Subscription object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

delete

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

Deletes an Subscription object.

Returns:

a Subscription object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

list

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

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

@Deprecated
public static ResourceList<Subscription> 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 Subscription 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 Subscription objects and the total number of Subscription objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

Retrieve Subscription 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.customer	Filter by the Id of the customer with the subscription
filter.plan	Filter by the Id of the plan linked to the subscription
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 subscription

^*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 id plan .

Returns:

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<Subscription> 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 Subscription objects using the specified criteria.

Parameters:

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

java.util.Map filter

filter.customer	Filter by the Id of the customer with the subscription
filter.plan	Filter by the Id of the plan linked to the subscription
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 subscription

^*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 id plan .

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 Subscription objects and the total number of Subscription objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

Retrieve Subscription 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.customer	Filter by the Id of the customer with the subscription
filter.plan	Filter by the Id of the plan linked to the subscription
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 subscription

^*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 id plan .

Returns:

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

find

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

Retrieve a Subscription 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 Subscription object to retrieve

Returns:

a Subscription object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

@Deprecated
public static Subscription 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 Subscription 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 Subscription object to retrieve

Returns:

a Subscription object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

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

Retrieve a Subscription 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 Subscription object to retrieve

Returns:

a Subscription object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

update

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

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

• amount
• billingCycle
• billingCycleLimit
• coupon
• currency
• currentPeriodEnd
• currentPeriodStart
• frequency
• frequencyPeriod
• name
• plan
• prorate (required)
• quantity
• renewalReminderLeadDays

Returns:

a Subscription object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException