CouponInput

duration: Specifies how long the discount will be in effect. Can be Duration.Forever, Duration.Once, or Duration.Repeating.
id: 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.
amountOff: A positive integer representing the amount to subtract from an invoice total (required if percentOff is not passed)
currency: Currency of the amountOff parameter (required if amountOff is passed)
durationInMonths: Required only if duration is Duration.Repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
maxRedemptions: 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.
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. This will be unset if you POST an empty value.
percentOff: A positive integer between 1 and 100 that represents the discount the coupon will apply (required if amountOff is not passed)
redeemBy: Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeemBy date, the coupon can no longer be applied to new customers.

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

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new CouponInput(duration: Duration, id: Option[String] = None, 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
Specifies how long the discount will be in effect. Can be Duration.Forever, Duration.Once, or Duration.Repeating.
id
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.
amountOff
A positive integer representing the amount to subtract from an invoice total (required if percentOff is not passed)
currency
Currency of the amountOff parameter (required if amountOff is passed)
durationInMonths
Required only if duration is Duration.Repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
maxRedemptions
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.
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. This will be unset if you POST an empty value.
percentOff
A positive integer between 1 and 100 that represents the discount the coupon will apply (required if amountOff is not passed)
redeemBy
Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeemBy date, the coupon can no longer be applied to new customers.

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]

A positive integer representing the amount to subtract from an invoice total (required if percentOff is not passed)
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Currency of the amountOff parameter (required if amountOff is passed)
val duration: Duration

Specifies how long the discount will be in effect.
Specifies how long the discount will be in effect. Can be Duration.Forever, Duration.Once, or Duration.Repeating.
val durationInMonths: Option[Long]

Required only if duration is Duration.Repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.
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: Option[String]

Unique string of your choice that will be used to identify this coupon when applying it to a customer.
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.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val maxRedemptions: Option[Long]

A positive integer specifying the number of times the coupon can be redeemed before it’s no longer valid.
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.
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. This will be unset if you POST an empty value.
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]

A positive integer between 1 and 100 that represents the discount the coupon will apply (required if amountOff is not passed)
val redeemBy: Option[OffsetDateTime]

Unix timestamp specifying the last time at which the coupon can be redeemed.
Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeemBy date, the coupon can no longer be applied to new customers.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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 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: Option[String]

final def isInstanceOf[T0]: 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

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 AnyRef

Inherited from Any

Ungrouped