Coupon (stripe-java 2.8.0 API)

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()

Constructors
Constructor and Description
`Coupon()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static CouponCollection`	`all(Map<String,Object> params)` Deprecated.
`static CouponCollection`	`all(Map<String,Object> params, RequestOptions options)` Deprecated.
`static CouponCollection`	`all(Map<String,Object> params, String apiKey)` Deprecated.
`static Coupon`	`create(Map<String,Object> params)`
`static Coupon`	`create(Map<String,Object> params, RequestOptions options)`
`static Coupon`	`create(Map<String,Object> params, String apiKey)` Deprecated.
`DeletedCoupon`	`delete()`
`DeletedCoupon`	`delete(RequestOptions options)`
`DeletedCoupon`	`delete(String apiKey)` Deprecated.
`Integer`	`getAmountOff()`
`Long`	`getCreated()`
`String`	`getCurrency()`
`String`	`getDuration()`
`Integer`	`getDurationInMonths()`
`String`	`getId()`
`Boolean`	`getLivemode()`
`Long`	`getMaxRedemptions()`
`Map<String,String>`	`getMetadata()`
`Integer`	`getPercentOff()`
`Long`	`getRedeemBy()`
`Integer`	`getTimesRedeemed()`
`Boolean`	`getValid()`
`static CouponCollection`	`list(Map<String,Object> params)`
`static CouponCollection`	`list(Map<String,Object> params, RequestOptions options)`
`static Coupon`	`retrieve(String id)`
`static Coupon`	`retrieve(String id, RequestOptions options)`
`static Coupon`	`retrieve(String id, String apiKey)` Deprecated.
`void`	`setAmountOff(Integer amountOff)`
`void`	`setCreated(Long created)`
`void`	`setCurrency(String currency)`
`void`	`setDuration(String duration)`
`void`	`setDurationInMonths(Integer durationInMonths)`
`void`	`setId(String id)`
`void`	`setLivemode(Boolean livemode)`
`void`	`setMaxRedemptions(Long maxRedemptions)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setPercentOff(Integer percentOff)`
`void`	`setRedeemBy(Long redeemBy)`
`void`	`setTimesRedeemed(Integer timesRedeemed)`
`void`	`setValid(Boolean valid)`
`Coupon`	`update(Map<String,Object> params)`
`Coupon`	`update(Map<String,Object> params, RequestOptions options)`
`Coupon`	`update(Map<String,Object> params, String apiKey)` Deprecated.

Methods inherited from class com.stripe.net.APIResource
classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setStripeResponseGetter, singleClassURL, singleClassURL, urlEncode

Methods inherited from class com.stripe.model.StripeObject
equals, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail
- Coupon
```
public Coupon()
```

Method Detail

getId
```
public String getId()
```
Specified by:

getId in interface HasId

setId
```
public void setId(String id)
```

getAmountOff
```
public Integer getAmountOff()
```

setAmountOff

public void setAmountOff(Integer amountOff)

getCreated
```
public Long getCreated()
```

setCreated
```
public void setCreated(Long created)
```

getCurrency
```
public String getCurrency()
```

setCurrency

public void setCurrency(String currency)

getDuration
```
public String getDuration()
```

setDuration

public void setDuration(String duration)

getDurationInMonths
```
public Integer getDurationInMonths()
```

setDurationInMonths

public void setDurationInMonths(Integer durationInMonths)

getLivemode
```
public Boolean getLivemode()
```

setLivemode

public void setLivemode(Boolean livemode)

getMaxRedemptions
```
public Long getMaxRedemptions()
```

setMaxRedemptions

public void setMaxRedemptions(Long maxRedemptions)

getMetadata
```
public Map<String,String> getMetadata()
```
Specified by:

getMetadata in interface MetadataStore<Coupon>

setMetadata

public void setMetadata(Map<String,String> metadata)

getPercentOff
```
public Integer getPercentOff()
```

setPercentOff

public void setPercentOff(Integer percentOff)

getRedeemBy
```
public Long getRedeemBy()
```

setRedeemBy

public void setRedeemBy(Long redeemBy)

getTimesRedeemed
```
public Integer getTimesRedeemed()
```

setTimesRedeemed

public void setTimesRedeemed(Integer timesRedeemed)

getValid
```
public Boolean getValid()
```

setValid
```
public void setValid(Boolean valid)
```

create

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

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

Specified by:: update in interface MetadataStore<Coupon>
Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

update

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

Specified by:: update in interface MetadataStore<Coupon>
Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

create

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

create

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

retrieve

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

list

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

list

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

all

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

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

Deprecated.

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

delete

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

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

Class Coupon

Nested Class Summary

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

Field Summary

Fields inherited from class com.stripe.net.APIResource

Fields inherited from class com.stripe.model.StripeObject

Constructor Summary

Method Summary

Methods inherited from class com.stripe.net.APIResource

Methods inherited from class com.stripe.model.StripeObject

Methods inherited from class java.lang.Object

Constructor Detail

Coupon

Method Detail

getId

setId

getAmountOff

setAmountOff

getCreated

setCreated

getCurrency

setCurrency

getDuration

setDuration

getDurationInMonths

setDurationInMonths

getLivemode

setLivemode

getMaxRedemptions

setMaxRedemptions

getMetadata

setMetadata

getPercentOff

setPercentOff

getRedeemBy

setRedeemBy

getTimesRedeemed

setTimesRedeemed

getValid

setValid

create

retrieve

update

update

update

create

create

retrieve

retrieve

list

list

all

all

all

delete

delete

delete