Name | Type | Description | Notes |
---|---|---|---|
externalCustomerId | String | The customer external unique identifier (provided by your own application) | |
couponCode | String | Unique code used to identify the coupon. | |
frequency | FrequencyEnum | The type of frequency for the coupon. It can have three possible values: `once`, `recurring` or `forever`. - If set to `once`, the coupon is applicable only for a single use. - If set to `recurring`, the coupon can be used multiple times for recurring billing periods. - If set to `forever`, the coupon has unlimited usage and can be applied indefinitely. | [optional] |
frequencyDuration | Integer | Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a `recurring` frequency type | [optional] |
amountCents | Integer | The amount of the coupon in cents. This field is required only for coupon with `fixed_amount` type. | [optional] |
amountCurrency | Currency | [optional] | |
percentageRate | String | The percentage rate of the coupon. This field is required only for coupons with a `percentage` coupon type. | [optional] |
Name | Value |
---|---|
ONCE | "once" |
RECURRING | "recurring" |