Apply a coupon

The customer external unique identifier (provided by your own application)

Unique code used to identify the coupon.

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.

Specifies the number of billing periods to which the coupon applies. This field is required only for coupons with a recurring frequency type

The amount of the coupon in cents. This field is required only for coupon with fixed_amount type.

The currency of the coupon. This field is required only for coupon with fixed_amount type.

The percentage rate of the coupon. This field is required only for coupons with a percentage coupon type.