com.stripe.param

Class CouponCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.CouponCreateParams

public class CouponCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CouponCreateParams.Builder
static class	CouponCreateParams.Duration

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

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static CouponCreateParams.Builder	builder()
java.lang.Long	getAmountOff() A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
java.lang.String	getCurrency() Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
CouponCreateParams.Duration	getDuration() Specifies how long the discount will be in effect.
java.lang.Long	getDurationInMonths() Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.lang.String	getId() Unique string of your choice that will be used to identify this coupon when applying it to a customer.
java.lang.Long	getMaxRedemptions() A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() A set of key-value pairs that you can attach to a coupon object.
java.lang.String	getName() Name of the coupon displayed to customers on, for instance invoices, or receipts.
java.math.BigDecimal	getPercentOff() A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
java.lang.Long	getRedeemBy() Unix timestamp specifying the last time at which the coupon can be redeemed.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static CouponCreateParams.Builder builder()

getAmountOff

public java.lang.Long getAmountOff()

A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).

getCurrency

public java.lang.String getCurrency()

Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).

getDuration

public CouponCreateParams.Duration getDuration()

Specifies how long the discount will be in effect. Can be `forever`, `once`, or `repeating`.

getDurationInMonths

public java.lang.Long getDurationInMonths()

Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

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

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getId

public java.lang.String getId()

Unique string of your choice that will be used to identify this coupon when applying it to a customer. This is often a specific code you'll give to your customer to use when signing up (e.g., `FALL25OFF`). If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.

getMaxRedemptions

public java.lang.Long getMaxRedemptions()

A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.

getMetadata

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

A set of key-value pairs that you can attach to a coupon object. It can be useful for storing additional information about the coupon in a structured format.

getName

public java.lang.String getName()

Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.

getPercentOff

public java.math.BigDecimal getPercentOff()

A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).

getRedeemBy

public java.lang.Long getRedeemBy()

Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.