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
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.
Coupon	delete() Delete a coupon.
Coupon	delete(RequestOptions options) Delete a coupon.
boolean	equals(java.lang.Object o)
java.lang.Long	getAmountOff()
java.lang.Long	getCreated()
java.lang.String	getCurrency()
java.lang.Boolean	getDeleted()
java.lang.String	getDuration()
java.lang.Long	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.math.BigDecimal	getPercentOff()
java.math.BigDecimal	getPercentOffPrecise() Deprecated. Prefer using the percentOff attribute instead.
java.lang.Long	getRedeemBy()
java.lang.Long	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, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Retrieve a coupon.
static Coupon	retrieve(java.lang.String id, RequestOptions options) Retrieve a coupon.
void	setAmountOff(java.lang.Long amountOff)
void	setCreated(java.lang.Long created)
void	setCurrency(java.lang.String currency)
void	setDeleted(java.lang.Boolean deleted)
void	setDuration(java.lang.String duration)
void	setDurationInMonths(java.lang.Long 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.math.BigDecimal percentOff)
void	setPercentOffPrecise(java.math.BigDecimal percentOffPrecise) Deprecated. Prefer using the percentOff attribute instead.
void	setRedeemBy(java.lang.Long redeemBy)
void	setTimesRedeemed(java.lang.Long 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.

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

create

public static Coupon create(java.util.Map<java.lang.String,java.lang.Object> params)
                     throws StripeException

Create a coupon.

Throws:

StripeException

create

public static Coupon create(java.util.Map<java.lang.String,java.lang.Object> params,
                            RequestOptions options)
                     throws StripeException

Create a coupon.

Throws:

StripeException

delete

public Coupon delete()
              throws StripeException

Delete a coupon.

Throws:

StripeException

delete

public Coupon delete(RequestOptions options)
              throws StripeException

Delete a coupon.

Throws:

StripeException

list

public static CouponCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                             throws StripeException

List all coupons.

Throws:

StripeException

list

public static CouponCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                    RequestOptions options)
                             throws StripeException

List all coupons.

Throws:

StripeException

retrieve

public static Coupon retrieve(java.lang.String id)
                       throws StripeException

Retrieve a coupon.

Throws:

StripeException

retrieve

public static Coupon retrieve(java.lang.String id,
                              RequestOptions options)
                       throws StripeException

Retrieve a coupon.

Throws:

StripeException

retrieve

public static Coupon retrieve(java.lang.String id,
                              java.util.Map<java.lang.String,java.lang.Object> params,
                              RequestOptions options)
                       throws StripeException

Retrieve a coupon.

Throws:

StripeException

update

public Coupon update(java.util.Map<java.lang.String,java.lang.Object> params)
              throws StripeException

Update a coupon.

Specified by:

update in interface MetadataStore<Coupon>

Throws:

StripeException

update

public Coupon update(java.util.Map<java.lang.String,java.lang.Object> params,
                     RequestOptions options)
              throws StripeException

Update a coupon.

Specified by:

update in interface MetadataStore<Coupon>

Throws:

StripeException

getObject

public java.lang.String getObject()

getAmountOff

public java.lang.Long getAmountOff()

getCreated

public java.lang.Long getCreated()

getCurrency

public java.lang.String getCurrency()

getDeleted

public java.lang.Boolean getDeleted()

getDuration

public java.lang.String getDuration()

getDurationInMonths

public java.lang.Long getDurationInMonths()

getLivemode

public java.lang.Boolean getLivemode()

getMaxRedemptions

public java.lang.Long getMaxRedemptions()

getName

public java.lang.String getName()

getPercentOff

public java.math.BigDecimal getPercentOff()

getRedeemBy

public java.lang.Long getRedeemBy()

getTimesRedeemed

public java.lang.Long getTimesRedeemed()

getValid

public java.lang.Boolean getValid()

getPercentOffPrecise

@Deprecated
public java.math.BigDecimal getPercentOffPrecise()

Deprecated. Prefer using the percentOff attribute instead.

The percent_off_precise attribute.

Returns:

the percent_off_precise attribute

See Also:

API version 2018-07-27

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)

setDeleted

public void setDeleted(java.lang.Boolean deleted)

setDuration

public void setDuration(java.lang.String duration)

setDurationInMonths

public void setDurationInMonths(java.lang.Long 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.math.BigDecimal percentOff)

setRedeemBy

public void setRedeemBy(java.lang.Long redeemBy)

setTimesRedeemed

public void setTimesRedeemed(java.lang.Long timesRedeemed)

setValid

public void setValid(java.lang.Boolean valid)

setPercentOffPrecise

@Deprecated
public void setPercentOffPrecise(java.math.BigDecimal percentOffPrecise)

Deprecated. Prefer using the percentOff attribute instead.

The percent_off_precise attribute.

See Also:

API version 2018-07-27

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>