Coupon

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public class Coupon
extends PaymentsObject
```
A Coupon 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 Coupon()

protected Coupon(java.util.Map m)

protected Coupon(PaymentsObject o)

Constructors
Modifier	Constructor and Description
`protected`	`Coupon()`
`protected`	`Coupon(java.util.Map m)`
`protected`	`Coupon(PaymentsObject o)`

Method Summary

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

Coupon
```
protected Coupon()
```

Coupon
```
protected Coupon(PaymentsObject o)
```

Coupon
```
protected Coupon(java.util.Map m)
```

Method Detail

getObjectType
```
protected java.lang.String getObjectType()
```
Specified by:

getObjectType in class PaymentsObject

create
```
public static Coupon create(java.util.Map map)
                     throws ApiCommunicationException,
                            AuthenticationException,
                            InvalidRequestException,
                            NotAllowedException,
                            SystemException
```
Creates an Coupon 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 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]

java.lang.String couponCode

Code that identifies the coupon to be used. [max length: 25, min length: 3] required

java.lang.String description

A brief section that describes the coupon. [max length: 1024]

java.lang.Integer durationInMonths

DEPRECATED - Duration in months that the coupon will be applied after it has first been selected. [min value: 1, max value: 9999]

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

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

java.lang.Integer numTimesApplied

The number of times a coupon will be applied on a customer's subscription. [min value: 1, max value: 9999]

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

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

Returns:

a Coupon object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create
```
@Deprecated
public static Coupon 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 Coupon 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 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]

java.lang.String couponCode

Code that identifies the coupon to be used. [max length: 25, min length: 3] required

java.lang.String description

A brief section that describes the coupon. [max length: 1024]

java.lang.Integer durationInMonths

DEPRECATED - Duration in months that the coupon will be applied after it has first been selected. [min value: 1, max value: 9999]

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

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

java.lang.Integer numTimesApplied

The number of times a coupon will be applied on a customer's subscription. [min value: 1, max value: 9999]

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

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

Returns:

a Coupon object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create
```
public static Coupon create(Authentication auth,
                            java.util.Map map)
                     throws ApiCommunicationException,
                            AuthenticationException,
                            InvalidRequestException,
                            NotAllowedException,
                            SystemException
```
Creates an Coupon 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 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]

java.lang.String couponCode

Code that identifies the coupon to be used. [max length: 25, min length: 3] required

java.lang.String description

A brief section that describes the coupon. [max length: 1024]

java.lang.Integer durationInMonths

DEPRECATED - Duration in months that the coupon will be applied after it has first been selected. [min value: 1, max value: 9999]

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

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

java.lang.Integer numTimesApplied

The number of times a coupon will be applied on a customer's subscription. [min value: 1, max value: 9999]

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

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

Returns:

a Coupon object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

delete

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

Deletes an Coupon object.

Returns:: a Coupon object.
Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

list

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

Retrieve Coupon 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 Coupon objects and the total number of Coupon objects available.
Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; NotAllowedException; SystemException
See Also:: ResourceList

list

@Deprecated
public static ResourceList<Coupon> 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 Coupon 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 Coupon objects and the total number of Coupon objects available.
Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; NotAllowedException; SystemException
See Also:: ResourceList

list

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

Retrieve Coupon 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 Coupon objects and the total number of Coupon objects available.
Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; NotAllowedException; SystemException
See Also:: ResourceList

list

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

Retrieve Coupon 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

^*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 maxRedemptions timesRedeemed id startDate endDate percentOff couponCode durationInMonths numTimesApplied amountOff .

Returns:

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

Parameters:

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

java.util.Map filter

^*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

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

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

Retrieve Coupon 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

^*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

Returns:

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

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

find

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

Retrieve a Coupon 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 Coupon object to retrieve
Returns:: a Coupon object
Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

find

@Deprecated
public static Coupon 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 Coupon 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 Coupon object to retrieve
Returns:: a Coupon object
Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

find

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

Retrieve a Coupon 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 Coupon object to retrieve
Returns:: a Coupon object
Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

update

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

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

endDate
maxRedemptions

Returns:: a Coupon object.
Throws:: ApiCommunicationException; AuthenticationException; InvalidRequestException; ObjectNotFoundException; NotAllowedException; SystemException

filter.id	Filter by the coupon Id
filter.text	Filter by the coupon code
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.startDateMin	Filter by the minimum coupon start date you are searching for - Date in UTC millis
filter.startDateMax	Filter by the maximum coupon start date you are searching for - Date in UTC millis
filter.endDateMin	Filter by the minimum coupon end date you are searching for - Date in UTC millis
filter.endDateMax	Filter by the maximum coupon end date you are searching for - Date in UTC millis

filter.id	Filter by the coupon Id
filter.text	Filter by the coupon code
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.startDateMin	Filter by the minimum coupon start date you are searching for - Date in UTC millis
filter.startDateMax	Filter by the maximum coupon start date you are searching for - Date in UTC millis
filter.endDateMin	Filter by the minimum coupon end date you are searching for - Date in UTC millis
filter.endDateMax	Filter by the maximum coupon end date you are searching for - Date in UTC millis

filter.id	Filter by the coupon Id
filter.text	Filter by the coupon code
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.startDateMin	Filter by the minimum coupon start date you are searching for - Date in UTC millis
filter.startDateMax	Filter by the maximum coupon start date you are searching for - Date in UTC millis
filter.endDateMin	Filter by the minimum coupon end date you are searching for - Date in UTC millis
filter.endDateMax	Filter by the maximum coupon end date you are searching for - Date in UTC millis

Class Coupon

Nested Class Summary

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

Field Summary

Fields inherited from class com.simplify.payments.PaymentsObject

Constructor Summary

Method Summary

Methods inherited from class com.simplify.payments.PaymentsObject

Methods inherited from class com.simplify.payments.PaymentsMap

Methods inherited from class java.util.LinkedHashMap

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Coupon

Coupon

Coupon

Method Detail

getObjectType

create

create

create

delete

list

list

list

list

list

list

find

find

find

update