com.stripe.model

Class Coupon

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.APIResource

com.stripe.model.Coupon

All Implemented Interfaces:

HasId, MetadataStore<Coupon>

public class Coupon
extends APIResource
implements MetadataStore<Coupon>, HasId

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.APIResource

APIResource.RequestMethod, APIResource.RequestType

Field Summary

Fields inherited from class com.stripe.net.APIResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor and Description
Coupon()

Method Summary

Modifier and Type	Method and Description
static CouponCollection	all(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.
static CouponCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
static CouponCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
protected boolean	canEqual(java.lang.Object other)
static Coupon	create(java.util.Map<java.lang.String,java.lang.Object> params) Create a coupon.
static Coupon	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Create a coupon.
static Coupon	create(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the create(Map, RequestOptions) method instead. This method will be removed in the next major version.
DeletedCoupon	delete() Delete a coupon.
DeletedCoupon	delete(RequestOptions options) Delete a coupon.
DeletedCoupon	delete(java.lang.String apiKey) Deprecated. Use the delete(RequestOptions) method instead. This method will be removed in the next major version.
boolean	equals(java.lang.Object o)
java.lang.Long	getAmountOff()
java.lang.Long	getCreated()
java.lang.String	getCurrency()
java.lang.String	getDuration()
java.lang.Integer	getDurationInMonths()
java.lang.String	getId()
java.lang.Boolean	getLivemode()
java.lang.Long	getMaxRedemptions()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getName()
java.lang.String	getObject()
java.lang.Integer	getPercentOff()
java.lang.Long	getRedeemBy()
java.lang.Integer	getTimesRedeemed()
java.lang.Boolean	getValid()
int	hashCode()
static CouponCollection	list(java.util.Map<java.lang.String,java.lang.Object> params) List all coupons.
static CouponCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) List all coupons.
static Coupon	retrieve(java.lang.String id) Retrieve a coupon.
static Coupon	retrieve(java.lang.String id, RequestOptions options) Retrieve a coupon.
static Coupon	retrieve(java.lang.String id, java.lang.String apiKey) Deprecated. Use the retrieve(String, RequestOptions) method instead. This method will be removed in the next major version.
void	setAmountOff(java.lang.Long amountOff)
void	setCreated(java.lang.Long created)
void	setCurrency(java.lang.String currency)
void	setDuration(java.lang.String duration)
void	setDurationInMonths(java.lang.Integer durationInMonths)
void	setId(java.lang.String id)
void	setLivemode(java.lang.Boolean livemode)
void	setMaxRedemptions(java.lang.Long maxRedemptions)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setName(java.lang.String name)
void	setObject(java.lang.String object)
void	setPercentOff(java.lang.Integer percentOff)
void	setRedeemBy(java.lang.Long redeemBy)
void	setTimesRedeemed(java.lang.Integer timesRedeemed)
void	setValid(java.lang.Boolean valid)
Coupon	update(java.util.Map<java.lang.String,java.lang.Object> params) Update a coupon.
Coupon	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Update a coupon.
Coupon	update(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey) Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Methods inherited from class com.stripe.net.APIResource

classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setExpandableFieldID, setStripeResponseGetter, singleClassURL, singleClassURL, subresourceURL, urlEncode

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Coupon

public Coupon()

Method Detail

all

@Deprecated
public static CouponCollection all(java.util.Map<java.lang.String,java.lang.Object> params)
                                        throws AuthenticationException,
                                               InvalidRequestException,
                                               APIConnectionException,
                                               CardException,
                                               APIException

Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.

List all coupons.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static CouponCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                               RequestOptions options)
                                        throws AuthenticationException,
                                               InvalidRequestException,
                                               APIConnectionException,
                                               CardException,
                                               APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all coupons.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static CouponCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                               java.lang.String apiKey)
                                        throws AuthenticationException,
                                               InvalidRequestException,
                                               APIConnectionException,
                                               CardException,
                                               APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List all coupons.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Coupon create(java.util.Map<java.lang.String,java.lang.Object> params)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Create a coupon.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Coupon create(java.util.Map<java.lang.String,java.lang.Object> params,
                            RequestOptions options)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Create a coupon.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

@Deprecated
public static Coupon create(java.util.Map<java.lang.String,java.lang.Object> params,
                                        java.lang.String apiKey)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Deprecated. Use the create(Map, RequestOptions) method instead. This method will be removed in the next major version.

Create a coupon.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

public DeletedCoupon delete()
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Delete a coupon.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

public DeletedCoupon delete(RequestOptions options)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

Delete a coupon.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

@Deprecated
public DeletedCoupon delete(java.lang.String apiKey)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Deprecated. Use the delete(RequestOptions) method instead. This method will be removed in the next major version.

Delete a coupon.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static CouponCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

List all coupons.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static CouponCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                    RequestOptions options)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

List all coupons.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Coupon retrieve(java.lang.String id)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Retrieve a coupon.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Coupon retrieve(java.lang.String id,
                              RequestOptions options)
                       throws AuthenticationException,
                              InvalidRequestException,
                              APIConnectionException,
                              CardException,
                              APIException

Retrieve a coupon.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

@Deprecated
public static Coupon retrieve(java.lang.String id,
                                          java.lang.String apiKey)
                                   throws AuthenticationException,
                                          InvalidRequestException,
                                          APIConnectionException,
                                          CardException,
                                          APIException

Deprecated. Use the retrieve(String, RequestOptions) method instead. This method will be removed in the next major version.

Retrieve a coupon.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Coupon update(java.util.Map<java.lang.String,java.lang.Object> params)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Update a coupon.

Specified by:

update in interface MetadataStore<Coupon>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Coupon update(java.util.Map<java.lang.String,java.lang.Object> params,
                     RequestOptions options)
              throws AuthenticationException,
                     InvalidRequestException,
                     APIConnectionException,
                     CardException,
                     APIException

Update a coupon.

Specified by:

update in interface MetadataStore<Coupon>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

@Deprecated
public Coupon update(java.util.Map<java.lang.String,java.lang.Object> params,
                                 java.lang.String apiKey)
                          throws AuthenticationException,
                                 InvalidRequestException,
                                 APIConnectionException,
                                 CardException,
                                 APIException

Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Update a coupon.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getObject

public java.lang.String getObject()

getAmountOff

public java.lang.Long getAmountOff()

getCreated

public java.lang.Long getCreated()

getCurrency

public java.lang.String getCurrency()

getDuration

public java.lang.String getDuration()

getDurationInMonths

public java.lang.Integer getDurationInMonths()

getLivemode

public java.lang.Boolean getLivemode()

getMaxRedemptions

public java.lang.Long getMaxRedemptions()

getName

public java.lang.String getName()

getPercentOff

public java.lang.Integer getPercentOff()

getRedeemBy

public java.lang.Long getRedeemBy()

getTimesRedeemed

public java.lang.Integer getTimesRedeemed()

getValid

public java.lang.Boolean getValid()

setId

public void setId(java.lang.String id)

setObject

public void setObject(java.lang.String object)

setAmountOff

public void setAmountOff(java.lang.Long amountOff)

setCreated

public void setCreated(java.lang.Long created)

setCurrency

public void setCurrency(java.lang.String currency)

setDuration

public void setDuration(java.lang.String duration)

setDurationInMonths

public void setDurationInMonths(java.lang.Integer durationInMonths)

setLivemode

public void setLivemode(java.lang.Boolean livemode)

setMaxRedemptions

public void setMaxRedemptions(java.lang.Long maxRedemptions)

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

setName

public void setName(java.lang.String name)

setPercentOff

public void setPercentOff(java.lang.Integer percentOff)

setRedeemBy

public void setRedeemBy(java.lang.Long redeemBy)

setTimesRedeemed

public void setTimesRedeemed(java.lang.Integer timesRedeemed)

setValid

public void setValid(java.lang.Boolean valid)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getId

public java.lang.String getId()

Specified by:

getId in interface HasId

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Specified by:

getMetadata in interface MetadataStore<Coupon>