When updating coupons that are already linked to an invoice or subscription you can only update the following parameters:
- name
- invoice name
- plan_constraint - Applicable when apply_on is set as each_specified_item. Allows change from none to all, none to specific, and specific to all.
- addon_constraint - Applicable when apply_on is set as each_specified_item. Allows change from none to all, none to specific, and specific to all.
- plan_ids - Applicable when plan_constraint is set as specific. Allows addition of new plan_ids. However, existing plan_ids cannot be removed.
- addon_ids - Applicable when addon_constraint is set as specific. Allows addition of new addon_ids. However, existing addon_ids cannot be removed.
- valid_till
- max_redemptions
- invoice_notes
- included_in_mrr
- meta_data
Sample Request
URL Format
Input Parameters
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 plan or addon 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 plan
or addon 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 plan
or addon
, 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 plan or addon specified by plan_ids
and addon_ids
.
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.
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 coupon is included in MRR calculations for your site. This attribute is only applicable for coupons of duration_type = one_time
and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude one-time coupons from MRR calculations, this value is always returned false
.
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.
Plans the coupon can be applied to.
Coupon not applicable to any plans.
Coupon applicable to all plans.
Coupon only applicable to specified plans. If used, it is mandatory to specify the plan(s).
Addons the coupon can be applied to.
Coupon not applicable to any addons.
Coupon applicable to all addons.
Coupon only applicable to specified addons. If used, it is mandatory to specify the addon(s).
Returns
Resource object representing coupon