POST /exports/coupons

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"

optional, string filter The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone. **Supported operators :** is, is_not, starts_with, in, not_in **Example →** *currency_code\[is\] = "USD"*

Parameters for coupon

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](https://www.urlencoder.org/) 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. * `specified_items_total` - **(Deprecated)** Discount will be applied to the total 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.
The coupon is applied to the invoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids. * `each_unit_of_specified_items` - **(Deprecated)** Discount will be applied to each unit of plan and addon items specified.

Possible values:

• "each_specified_item"
• "invoice_amount"

* `invoice_amount` - The coupon is applied to the invoice sub_total. * `specified_items_total` - **(Deprecated)** Discount will be applied to the total 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.
The coupon is applied to the invoice.line_item.amount that corresponds to the plan or addon specified by plan_ids and addon_ids. * `each_unit_of_specified_items` - **(Deprecated)** Discount will be applied to each unit of plan and addon items specified.

Possible values:

• "each_specified_item"
• "invoice_amount"

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](https://www.urlencoder.org/) the name of the coupon set in the path parameter before making an API call.

Specifies the time duration for which this coupon is attached to the subscription.

* `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. * `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed. * `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"

* `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. * `forever` - The coupon is attached to the subscription and applied on the invoices until explicitly removed. * `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"

The type of deduction

* `fixed_amount` - The specified amount will be deducted. * `percentage` - The specified percentage will be deducted. * `offer_quantity` - The specified units will be offered without any deduction.

Possible values:

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

* `fixed_amount` - The specified amount will be deducted. * `percentage` - The specified percentage will be deducted. * `offer_quantity` - The specified units will be offered without any deduction.

Possible values:

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

Status of the coupon.

* `active` - Can be applied to a subscription. * `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. * `deleted` - Indicates the coupon has been deleted. * `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.

Possible values:

• "active"
• "deleted"
• "future"
• "archived"
• "expired"

* `active` - Can be applied to a subscription. * `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. * `deleted` - Indicates the coupon has been deleted. * `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.

Possible values:

• "active"
• "deleted"
• "future"
• "archived"
• "expired"

Timestamp indicating when this coupon is created.

To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.