POST /coupons/create_for_items

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Possible values:

• "all-disabled"

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

skip all actions to be done on the events

Possible values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

skip only emails

Possible values:

• "all-disabled"

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 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.

Display name used in invoice. If it is not configured then name is used in invoice.

The currency code (ISO 4217 format) of the coupon. Applicable for fixed_amount coupons alone.

A collection of key-value pairs that provides extra information about the coupon. **Note:** There's a character limit of 65,535. [Learn more](advanced-features?prod_cat_ver=2#metadata).

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. .

Status of the coupon. * future - The coupon is scheduled to start at a future date and cannot be applied to a subscription. From the valid_from date, the status changes to active. * expired - Cannot be applied to a subscription. A coupon may expire due to exceeding max_redemptions or valid_till date is past. Existing associations remain unaffected. * archived - Cannot be applied to a subscription. Existing associations remain unaffected. * active - Can be applied to a subscription. * deleted - Indicates the coupon has been deleted.

Possible values:

• "active"
• "archived"

Default value: "active"

(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.

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.

Parameters for `coupon_constraints`. Multiple `coupon_constraints` can be passed by specifying unique indices.

The value of the coupon constraint. The possible values depend on the value of constraints[type]:

• When type is unique_by, then value can be email or id.

• When type is max_redemptions, then value can be any integer in the range 1 coupon.max_redemptions, inclusive.

• When type is new_customer or existing_customer then value can be based_on_invoice.

Parameters for item_constraints

List of item price ids for which this coupon is applicable.

Note:

When specifying a value for item_price_ids, make sure that the value is wrapped in square brackets ([]), for example: [cbdemo_advanced-USD-Daily] instead of cbdemo_advanced-USD-Daily; otherwise, a param_wrong_value error returns.

For information about item_price_ids, refer to Defining Price Points in Plans, Addons, and Charges.

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 amount on the invoice to which the coupon is applied. * invoice_amount - The coupon is applied to the invoice sub_total. * each_unit_of_specified_items - Discount will be applied to each unit of plan and addon items specified. * each_specified_item - The coupon is applied to the invoice.line_item.amount that corresponds to the item price specified by item_price_id. * specified_items_total - Discount will be applied to the total of plan and addon items specified.

Possible values:

• "each_specified_item"
• "invoice_amount"

The unit of time for period. Applicable only when duration_type is limited_period. * month - A period of 1 calendar month. * week - A period of 7 days. * year - A period of 1 calendar year. * day - A period of 24 hours.

Possible values:

• "month"
• "day"
• "week"
• "year"

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. .

The duration of time for which the coupon is attached to the subscription, in period_units. Applicable only when duration_type is limited_period.

Specifies the time duration for which this coupon is attached to the subscription. * forever - The coupon is attached to the subscription and applied on the invoices until explicitly removed. * one_time - The coupon stays attached to the subscription till it is applied on an invoice once . It is removed after that from the subscription. * limited_period - 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.

Possible values:

• "limited_period"
• "forever"
• "one_time"

Default value: "forever"

Specifies the type of discount to be applied. * percentage - A percentage of the original price is deducted as a discount. The discount percentage is specified in discount_percentage.
Learn more about percentage coupons. * fixed_amount - A fixed amount is deducted as a discount. The discount amount is specified in discount_amount.
Learn more about fixed_amount coupons. * offer_quantity - 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.

Possible values:

• "fixed_amount"
• "offer_quantity"
• "percentage"

Default value: "percentage"

The value of the deduction. The format of this value depends on the kind of currency.

The percentage of the original amount that should be deducted from it.

Parameters for item_constraint_criteria

List of currencies (ISO 4217 format) for which this coupon is applicable.

Pass the item price period units for this criterion. period followed by period_units. Such as [1 day,1 week,3 month,6 month]

List of families for which this coupon is applicable.