Coupon codes

API Version

Library

Coupon codes are used along with existing coupons in Chargebee. You can create a coupon set using a bunch of coupon codes and this coupon set will be associated with an existing coupon. A coupon code can only be applied to a single subscription and cannot be re-used.

Using coupon codes you can distribute several unique codes for a single main coupon, when you are running promotions.

Sample coupon code [ JSON ]

{
    "code": "CBCCN345",
    "coupon_id": "alpha1",
    "coupon_set_name": "Welcome Offer",
    "object": "coupon_code"
}

code

string, max chars=50
Unique coupon code that can be redeemed only once.

coupon_id

string, max chars=100
Id of the main coupon resource.

coupon_set_name

string, max chars=50
Coupon 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.

Create a new coupon code and associate it to an existing main coupon resource.

Sample Request

curl  https://{site}.chargebee.com/api/v1/coupon_codes \
     -u {site_api_key}:\
     -d coupon_id="alpha1" \
     -d coupon_set_name="Welcome Offer" \
     -d code="CBCCN345"

copy

Click to Copy

Sample Response [ JSON ]

{
    "coupon_code": {
        "code": "CBCCN345",
        "coupon_id": "alpha1",
        "coupon_set_name": "Welcome Offer",
        "object": "coupon_code"
    }
}

URL Format POST

https://{site}.chargebee.com/api/v1/coupon_codes

coupon_id[]

required, string, max chars=100
Id of the main coupon resource.

coupon_set_name[]

required, string, max chars=50
Coupon 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.

code[]

required, string, max chars=50
Unique coupon code that can be redeemed only once.

coupon_code

always returned
Resource object representing coupon_code

Retrieves a specific coupon code details.

Sample Request

curl  https://{site}.chargebee.com/api/v1/coupon_codes/CBC978B \
     -u {site_api_key}:

copy

Click to Copy

Sample Response [ JSON ]

{
    "coupon_code": {
        "code": "CBC978B",
        "coupon_id": "alpha",
        "coupon_set_name": "Offer",
        "object": "coupon_code"
    }
}

URL Format GET

https://{site}.chargebee.com/api/v1/coupon_codes/{coupon-code-code}

coupon_code

always returned
Resource object representing coupon_code

Sample coupon code [ JSON ]

API Index URL GET

Model Class

Coupon code attributes

Consent Fields for Coupon code

Custom Fields for Coupon code

Create a coupon code for a coupon ¶

Notes

Sample Response [ JSON ]

URL Format POST

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL

Retrieve a coupon code ¶

Notes

Sample Response [ JSON ]

URL Format GET

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL