Create a coupon

The name of the coupon.

Unique code used to identify the coupon.

Description of the coupon.

The type of the coupon. It can have two possible values: fixed_amount or percentage.

• If set to fixed_amount, the coupon represents a fixed amount discount.
• If set to percentage, the coupon represents a percentage-based discount.

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.

Indicates whether the coupon can be reused or not. If set to true, the coupon is reusable, meaning it can be applied multiple times to the same customer. If set to false, the coupon can only be used once and is not reusable. If not specified, this field is set to true by default.

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

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

Specifies the type of expiration for the coupon. It can have two possible values: time_limit or no_expiration.

• If set to time_limit, the coupon has an expiration based on a specified time limit.
• If set to no_expiration, the coupon does not have an expiration date and remains valid indefinitely.

The expiration date and time of the coupon. This field is required only for coupons with expiration set to time_limit. The expiration date and time should be specified in UTC format according to the ISO 8601 datetime standard. It indicates the exact moment when the coupon will expire and is no longer valid.