GET /coupons

List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`chargebee-business-entity-id`	String	No	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.
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	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.

Query parameters

Name	Type	Required	Description
`currency_code`	Object	No	optional, string filter The currency code (ISO 4217 format ) of the coupon. Applicable for fixed_amount coupons alone. Supported operators : is, is_not, starts_with, in, not_in Example → currency_code[is] = "USD"
`status`	Object	No	optional, enumerated string filter Status of the coupon. Possible values are : active, expired, archived, deleted. Supported operators : is, is_not, in, not_in Example → status[is_not] = "active"
`updated_at`	Object	No	optional, timestamp(UTC) in seconds filter To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09. Supported operators : after, before, on, between Example → updated_at[on] = "1243545465"
`id`	Object	No	optional, string filter 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. . Supported operators : is, is_not, starts_with, in, not_in Example → id[is] = "OFF2008"
`apply_on`	Object	No	optional, enumerated string filter The amount on the invoice to which the coupon is applied. Possible values are : invoice_amount, each_specified_item. Supported operators : is, is_not, in, not_in Example → apply_on[is] = "invoice_amount"
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`name`	Object	No	optional, string filter 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. . Supported operators : is, is_not, starts_with, in, not_in Example → name[is_not] = "Offer 10"
`duration_type`	Object	No	optional, enumerated string filter Specifies the time duration for which this coupon is attached to the subscription. Possible values are : one_time, forever, limited_period. Supported operators : is, is_not, in, not_in Example → duration_type[is] = "forever"
`discount_type`	Object	No	optional, enumerated string filter The type of deduction. Possible values are : fixed_amount, percentage. Supported operators : is, is_not, in, not_in Example → discount_type[is] = "fixed_amount"
`created_at`	Object	No	optional, timestamp(UTC) in seconds filter Timestamp indicating when this coupon is created. Supported operators : after, before, on, between Example → created_at[before] = "145222875"
`sort_by`	Object	No	optional, string filter Sorts based on the specified attribute. Supported attributes : created_at Supported sort-orders : asc, desc Example → sort_by[asc] = "created_at" This will sort the result based on the 'created_at' attribute in ascending(earliest first) order.
`offset`	String	No	Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.
`applicable_item_price_ids`	Object	No	optional, string filter List of itemPrice ids for which these coupons are applicable. Supported operators : in, is Example → applicable_item_price_ids[is] = "day-pass-USD"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.