This API creates a new coupon for a specific promotion or offers.
Sample Request
URL Format
Input Parameters
Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
Note:
When the coupon ID contains a special character; for example: #, the API returns an error. Make sure that you encode the coupon ID in the path parameter before making an API call.
.
The display name used in web interface for identifying the coupon.
Note:
When the name of the coupon set contains a special character; for example: #, the API returns an error. Make sure that you encode the name of the coupon set in the path parameter before making an API call.
.
Display name used in invoice. If it is not configured then name is used in invoice.
Specifies the type of discount to be applied.
A fixed amount is deducted as a discount. The discount amount is specified in discount_amount.
Learn more
about fixed_amount
coupons.
A percentage of the original price is deducted as a discount. The discount percentage is specified in discount_percentage.
Learn more
about percentage
coupons.
A specified number of units of the item price are offered for free. The number of free units is specified in discount_quantity.
The offer_quantity
option is valid only when apply_on
is set to each_specified_item
and the pricing_model
of the item price is per_unit.
Learn more
about offer_quantity
coupons.
The value of the deduction. The format of this value depends on the kind of currency .
The currency code (ISO 4217 format ) of the coupon. Applicable for fixed_amount coupons alone.
The percentage of the original amount that should be deducted from it.
Specifies the number of free units provided for the item price
, without affecting the total quantity sold. This parameter is applicable only when the discount_type
is set to offer_quantity
.
The amount on the invoice to which the coupon is applied.
The coupon is applied to the invoice sub_total
.
The coupon is applied to the invoice.line_item.amount
that corresponds to the item price specified by item_price_id
.
Specifies the time duration for which this coupon is attached to the subscription.
The coupon stays attached to the subscription till it is applied on an invoice once. It is removed after that from the subscription.
The coupon is attached to the subscription and applied on the invoices until explicitly removed.
The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by period
and period_unit
.
(Deprecated)
The duration of time in months for which the coupon is attached to the subscription. Applicable only when duration_type
is limited_period.
Note:
This parameter has been deprecated. Use period
and period_unit
instead.
The date from which the coupon can be applied to subscriptions.
Date upto which the coupon can be applied to new subscriptions.
Maximum number of times this coupon can be redeemed.
Note:
If not specified, the coupon can be redeemed an indefinite number of times.
.
A customer-facing note added to all invoices associated with this API resource. This note becomes one among all the notes displayed on the invoice PDF.
A collection of key-value pairs that provides extra information about the coupon.
Note: There's a character limit of 65,535.
The duration of time for which the coupon is attached to the subscription, in period_units.
Applicable only when duration_type
is limited_period
.
The unit of time for period. Applicable only when duration_type
is limited_period
.
A period of 24 hours.
A period of 7 days.
A period of 1 calendar month.
A period of 1 calendar year.
Status of the coupon.
Can be applied to a subscription.
Cannot be applied to a subscription. Existing associations remain unaffected.
Returns
Resource object representing coupon