API Version
Product Catalog
Library

A coupon set contains a bunch of coupon codes that can be redeemed by your customers when they are checking out. It belongs to an existing coupon and will usually be combined with other coupons that share similar promotion or discount offers. Using this resource, you can create, update, retrieve, delete coupon sets and add coupon codes to a coupon set.

Sample coupon set [ JSON ]

{ "archived_count": 0, "coupon_id": "beta", "id": "cs_3RtyuIHol", "name": "Launch Promotion", "object": "coupon_set", "redeemed_count": 0, "total_count": 0 }

API Index URL GET

https://{site}.chargebee.com/api/v2/coupon_sets

Model Class

id
string, max chars=50
Uniquely identifies a coupon_set
coupon_id
string, max chars=100
Coupon id linked to coupon set
name
string, max chars=50
Name of the coupon set
total_count
optional, integer
No of coupon codes present in coupon set
redeemed_count
optional, integer
No of redeemed codes
archived_count
optional, integer
No of archived codes
id id
string, max chars=50
Uniquely identifies a coupon_set
coupon_id coupon_id
string, max chars=100
Coupon id linked to coupon set
name name
string, max chars=50
Name of the coupon set
total_count total_count
optional, integer
No of coupon codes present in coupon set
redeemed_count redeemed_count
optional, integer
No of redeemed codes
archived_count archived_count
optional, integer
No of archived codes
Create a coupon set with a coupon code compatible to your product offers and promotional discounts

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/coupon_sets \
     -u {site_api_key}:\
     -d coupon_id="beta" \
     -d name="Launch Promotion" \
     -d id="cs_3RtyuIHol"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "coupon_set": {
        "archived_count": 0,
        "coupon_id": "beta",
        "id": "cs_3RtyuIHol",
        "name": "Launch Promotion",
        "object": "coupon_set",
        "redeemed_count": 0,
        "total_count": 0
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/coupon_sets

Method

coupon_id[]
required, string, max chars=100
Coupon id linked to coupon set.
name[]
required, string, max chars=50
Name of the coupon set.
id[]
required, string, max chars=50
Uniquely identifies a coupon_set.
meta_data[]
optional, jsonobject
A collection of key-value pairs that provides extra information about the coupon set.
Note: There's a character limit of 65,535.
Learn more.
coupon_set coupon_set
always returned
Resource object representing coupon_set

Sample admin console URL

https://{site}.chargebee.com/admin-console/coupon_sets/123x

This API add coupon codes to an existing coupon set.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/coupon_sets/cs_3RtyuLol/add_coupon_codes \
     -u {site_api_key}:\
     -d code="CBCC789"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "coupon_set": {
        "archived_count": 0,
        "coupon_id": "sample_coupon",
        "id": "cs_3RtyuLol",
        "name": "Weekend Offer",
        "object": "coupon_set",
        "redeemed_count": 0,
        "total_count": 1
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/coupon_sets/{coupon-set-id}/add_coupon_codes

Method

code[[0..n]][0..n]
optional, list of string
You can pass up to 100 values per API call. You can also use the Chargebee UI to pass up to 1000 codes per operation. There is no limit on the total number of coupon codes that can be included in a coupon set.
coupon_set coupon_set
always returned
Resource object representing coupon_set

Sample admin console URL

https://{site}.chargebee.com/admin-console/coupon_sets/123x
Use this API to get the list of all the coupon sets.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/coupon_sets \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=2
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "list": [
        {
            "coupon_set": {
                "archived_count": 0,
                "coupon_id": "sample_coupon",
                "id": "cs_3RtyuLol",
                "name": "Weekend Offer",
                "object": "coupon_set",
                "redeemed_count": 0,
                "total_count": 1
            }
        },
        {..}
    ],
    "next_offset": "[\"154000000001\",\"1517501418000\"]"
}

URL Format GET

https://{site}.chargebee.com/api/v2/coupon_sets

Method

limit[]
optional, integer, default=10, min=1, max=100
The number of resources to be returned.
offset[]
optional, string, max chars=1000
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.
Filter Params
For operator usages, see the Pagination and Filtering section.
id[<operator>]
optional, string filter
Uniquely identifies a coupon_set. Possible values are :
Supported operators : is, is_not, starts_with, in, not_in

Example id[is] = "bulk-codes-1"
id[is][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
id[is_not][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
id[starts_with][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
id[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
id[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
name[<operator>]
optional, string filter
Name of the coupon set. Possible values are :
Supported operators : is, is_not, starts_with, in, not_in

Example name[is] = "bulk-codes-1"
name[is][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
name[is_not][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
name[starts_with][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
name[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
name[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
coupon_id[<operator>]
optional, string filter
Coupon id linked to coupon set. Possible values are :
Supported operators : is, is_not, starts_with, in, not_in

Example coupon_id[is] = "OFF2008"
coupon_id[is][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
coupon_id[is_not][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
coupon_id[starts_with][operator]
optional, string, min chars=1 filter
Possible values are :
Supported operators :

Example
coupon_id[in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
coupon_id[not_in][operator]
optional, string filter
Possible values are :
Supported operators :

Example
total_count[<operator>]
optional, number filter
No of coupon codes present in coupon set. Possible values are :
Supported operators : is, is_not, lt, lte, gt, gte, between

Example total_count[is] = "10"
total_count[is][operator]
optional, number filter
Possible values are :
Supported operators :

Example
total_count[is_not][operator]
optional, number filter
Possible values are :
Supported operators :

Example
total_count[lt][operator]
optional, number filter
Possible values are :
Supported operators :

Example
total_count[lte][operator]
optional, number filter
Possible values are :
Supported operators :

Example
total_count[gt][operator]
optional, number filter
Possible values are :
Supported operators :

Example
total_count[gte][operator]
optional, number filter
Possible values are :
Supported operators :

Example
total_count[between][operator]
optional, string filter
Possible values are :
Supported operators :

Example
redeemed_count[<operator>]
optional, number filter
No of redeemed codes. Possible values are :
Supported operators : is, is_not, lt, lte, gt, gte, between

Example redeemed_count[is] = "5"
redeemed_count[is][operator]
optional, number filter
Possible values are :
Supported operators :

Example
redeemed_count[is_not][operator]
optional, number filter
Possible values are :
Supported operators :

Example
redeemed_count[lt][operator]
optional, number filter
Possible values are :
Supported operators :

Example
redeemed_count[lte][operator]
optional, number filter
Possible values are :
Supported operators :

Example
redeemed_count[gt][operator]
optional, number filter
Possible values are :
Supported operators :

Example
redeemed_count[gte][operator]
optional, number filter
Possible values are :
Supported operators :

Example
redeemed_count[between][operator]
optional, string filter
Possible values are :
Supported operators :

Example
archived_count[<operator>]
optional, number filter
No of archived codes. Possible values are :
Supported operators : is, is_not, lt, lte, gt, gte, between

Example archived_count[is] = "2"
archived_count[is][operator]
optional, number filter
Possible values are :
Supported operators :

Example
archived_count[is_not][operator]
optional, number filter
Possible values are :
Supported operators :

Example
archived_count[lt][operator]
optional, number filter
Possible values are :
Supported operators :

Example
archived_count[lte][operator]
optional, number filter
Possible values are :
Supported operators :

Example
archived_count[gt][operator]
optional, number filter
Possible values are :
Supported operators :

Example
archived_count[gte][operator]
optional, number filter
Possible values are :
Supported operators :

Example
archived_count[between][operator]
optional, string filter
Possible values are :
Supported operators :

Example
coupon_set coupon_set
always returned
Resource object representing coupon_set
next_offset next_offset
optional, string, max chars=1000
This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

Sample admin console URL

https://{site}.chargebee.com/admin-console/coupon_sets/123x

Use this API to retrieve a specific coupon set.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/coupon_sets/cs_3RtyuLop \
     -u {site_api_key}:
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "coupon_set": {
        "archived_count": 0,
        "coupon_id": "beta2",
        "id": "cs_3RtyuLop",
        "name": "Clearance Offer",
        "object": "coupon_set",
        "redeemed_count": 0,
        "total_count": 0
    }
}

URL Format GET

https://{site}.chargebee.com/api/v2/coupon_sets/{coupon-set-id}

Method

coupon_set coupon_set
always returned
Resource object representing coupon_set

Sample admin console URL

https://{site}.chargebee.com/admin-console/coupon_sets/123x

Use this API to update a specific coupon set by updating its name and the meta_data.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/coupon_sets/cs_3Rtyuqop/update \
     -u {site_api_key}:\
     -d name="Promotional Offer"
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "coupon_set": {
        "archived_count": 0,
        "coupon_id": "beta3",
        "id": "cs_3Rtyuqop",
        "name": "Promotional Offer",
        "object": "coupon_set",
        "redeemed_count": 0,
        "total_count": 0
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/coupon_sets/{coupon-set-id}/update

Method

name[]
optional, string, max chars=50
Name of the coupon set.
meta_data[]
optional, jsonobject
A collection of key-value pairs that provides extra information about the coupon set.
Note: There's a character limit of 65,535.
Learn more.
coupon_set coupon_set
always returned
Resource object representing coupon_set

Sample admin console URL

https://{site}.chargebee.com/admin-console/coupon_sets/123x
Use this endpoint to delete a specific coupon set

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/coupon_sets/cs_3Rtyupop/delete \
     -X POST  \
     -u {site_api_key}:
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "coupon_set": {
        "archived_count": 0,
        "coupon_id": "beta4",
        "id": "cs_3Rtyupop",
        "name": "Launch Offer",
        "object": "coupon_set",
        "redeemed_count": 0,
        "total_count": 0
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/coupon_sets/{coupon-set-id}/delete

Method

coupon_set coupon_set
always returned
Resource object representing coupon_set

Sample admin console URL

https://{site}.chargebee.com/admin-console/coupon_sets/123x

Use this API to delete all the unutilised coupon codes from a specific coupon set.

Notes

Sample Request
curl  https://{site}.chargebee.com/api/v2/coupon_sets/cs_3RtyuSuN/delete_unused_coupon_codes \
     -X POST  \
     -u {site_api_key}:
copy
Click to Copy

Sample Response [ JSON ]

Show more...
{
    "coupon_set": {
        "archived_count": 0,
        "coupon_id": "beta5",
        "id": "cs_3RtyuSuN",
        "name": "Welcome Offer",
        "object": "coupon_set",
        "redeemed_count": 0,
        "total_count": 0
    }
}

URL Format POST

https://{site}.chargebee.com/api/v2/coupon_sets/{coupon-set-id}/delete_unused_coupon_codes

Method

coupon_set coupon_set
always returned
Resource object representing coupon_set

Sample admin console URL

https://{site}.chargebee.com/admin-console/coupon_sets/123x