Coupon

Attributes of the Coupon type

The coupon record that can be applied to a subscription

Name
Type
Description

active

Boolean

Is the coupon active

couponCode

String

Unique coupon code

createdAt

ISO8601DateTime

Datetime the coupon was created

currencyId

ID

Currency ID of the coupon

description

String

Description of the coupon

discountAmount

Float

Amount of the discount

discountKind

Type of discount the coupon applies

discountPercentage

Float

Percent of the discount

id

ID

Unique ID for the coupon

name

String

Name of the coupon

planId

ID

Plan ID the coupon applies to

redemptionEndDate

ISO8601Date

Date the coupon expires

redemptionsCount

Int

Number of times the coupon has been redeemed

redemptionsMax

Int

Maximum number of times the coupon can be redeemed

updatedAt

ISO8601DateTime

Datetime the coupon was last updated

Last updated

Was this helpful?