Coupon

duration: One of Duration.Forever, Duration.Once, and Duration.Repeating. Describes how long a customer who applies this coupon will get the discount.
timesRedeemed: Number of times this coupon has been applied to a customer.
valid: Taking account of the above properties, whether this coupon can still be applied to a customer
amountOff: Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
currency: If amountOff has been set, the currency of the amount to take off.
durationInMonths: If duration is repeating, the number of months the coupon applies. None if coupon duration is forever or once.
maxRedemptions: Maximum number of times this coupon can be redeemed, in total, before it is no longer valid.
metadata: 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.
percentOff: Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percentOff of 50 will make a $100 invoice $50 instead.
redeemBy: Date after which the coupon can no longer be redeemed

See also: https://stripe.com/docs/api#coupons

Linear Supertypes

Serializable, Serializable, Product, Equals, StripeObject, AnyRef, Any

Instance Constructors

new Coupon(id: String, created: OffsetDateTime, duration: Duration, livemode: Boolean, timesRedeemed: Long, valid: Boolean, amountOff: Option[Long] = None, currency: Option[Currency] = None, durationInMonths: Option[Long] = None, maxRedemptions: Option[Long] = None, metadata: Option[Map[String, String]] = None, percentOff: Option[BigDecimal] = None, redeemBy: Option[OffsetDateTime] = None)

duration
One of Duration.Forever, Duration.Once, and Duration.Repeating. Describes how long a customer who applies this coupon will get the discount.
timesRedeemed
Number of times this coupon has been applied to a customer.
valid
Taking account of the above properties, whether this coupon can still be applied to a customer
amountOff
Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
currency
If amountOff has been set, the currency of the amount to take off.
durationInMonths
If duration is repeating, the number of months the coupon applies. None if coupon duration is forever or once.
maxRedemptions
Maximum number of times this coupon can be redeemed, in total, before it is no longer valid.
metadata
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.
percentOff
Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percentOff of 50 will make a $100 invoice $50 instead.
redeemBy
Date after which the coupon can no longer be redeemed

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val amountOff: Option[Long]

Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val created: OffsetDateTime
val currency: Option[Currency]

If amountOff has been set, the currency of the amount to take off.
val duration: Duration

One of Duration.Forever, Duration.Once, and Duration.Repeating.
One of Duration.Forever, Duration.Once, and Duration.Repeating. Describes how long a customer who applies this coupon will get the discount.
val durationInMonths: Option[Long]

If duration is repeating, the number of months the coupon applies.
If duration is repeating, the number of months the coupon applies. None if coupon duration is forever or once.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val id: String
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val livemode: Boolean
val maxRedemptions: Option[Long]

Maximum number of times this coupon can be redeemed, in total, before it is no longer valid.
val metadata: Option[Map[String, String]]

A set of key/value pairs that you can attach to a coupon object.
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.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val percentOff: Option[BigDecimal]

Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.
Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percentOff of 50 will make a $100 invoice $50 instead.
val redeemBy: Option[OffsetDateTime]

Date after which the coupon can no longer be redeemed
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timesRedeemed: Long

Number of times this coupon has been applied to a customer.
val valid: Boolean

Taking account of the above properties, whether this coupon can still be applied to a customer
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package Coupons

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val amountOff: Option[Long]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val created: OffsetDateTime

val currency: Option[Currency]

val duration: Duration

val durationInMonths: Option[Long]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val id: String

final def isInstanceOf[T0]: Boolean

val livemode: Boolean

val maxRedemptions: Option[Long]

val metadata: Option[Map[String, String]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val percentOff: Option[BigDecimal]

val redeemBy: Option[OffsetDateTime]

final def synchronized[T0](arg0: ⇒ T0): T0

val timesRedeemed: Long

val valid: Boolean

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from StripeObject

Inherited from AnyRef

Inherited from Any

Ungrouped