GET /coupon_codes
List the available coupon codes.
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 |
|---|---|---|---|
limit |
Integer | No |
The number of resources to be returned. Default value: 10 |
coupon_id |
Object | No |
optional, string filterId of the main coupon resource.Supported operators : is, is_not, starts_with, in, not_inExample → coupon_id[is] = "OFF20" |
status |
Object | No |
optional, enumerated string filterStatus of the coupon code. Possible values are : not_redeemed, redeemed, archived.Supported operators : is, is_not, in, not_inExample → status[is] = "redeemed" |
code |
Object | No |
optional, string filterUnique coupon code that can be redeemed only once.Supported operators : is, is_not, starts_with, in, not_inExample → code[is_not] = "OFF2009" |
offset |
String | No |
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set |
coupon_set_name |
Object | No |
optional, string filterCoupon set name to which this coupon code would be grouped under. If the coupon set with the passed name is not present, a new coupon set will be created.Supported operators : is, is_not, starts_withExample → coupon_set_name[is_not] = "OFF20" |
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.