Settings
API Version
Product Catalog
Library

Coupon codes

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" }

API Index URL GET

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

Model Class

 

      Coupon code attributes
      
 
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. 
 
 
 
Event types
 

      This is a list of the event types we currently support. We will continue
      to add more events moving forward. All events follow a uniform pattern -
      <resource>_<event_name>. The resources that will be
      present in the event content are provided beneath each event type's
      description.
    
 
Note: If consolidated invoicing is enabled, the
      attributes invoice.subscription_id and
      credit_note.subscription_id should not be used
      (as it will not be present if the invoice / credit note has lines from
      multiple subscriptions). Instead to know the related subscriptions,
      their line_items' subscription_id attribute should be referred.
    
 
 
code code
 

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

          string, max chars=100
 Id of the main coupon resource. 
 
coupon_set_name 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. 
 
 
 
Consent Fields for Coupon code
 
 
Custom Fields for Coupon code
 
  

      Create a coupon code for a coupon
      
 
Idempotency Supported
 
 
Create a new coupon code and associate it to an existing main coupon resource.
  
Notes
 
 

        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 ]
 
Show more...
 
{
    "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
    
 
Method
 
 
Input Parameters
 
  
 
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. 
 
 
    
 
Returns
 
coupon_code  coupon_code
 

      always returned 
 Resource object representing coupon_code
 
Sample admin console URL
 

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

      Retrieve a coupon code
      
  
 
Retrieves a specific coupon code details.
  
Notes
 
 

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

      copy
      
Click to Copy
 
 

    Sample Response [ JSON ]
 
Show more...
 
{
    "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}
    
 
Method
 
  
   
 
    
 
Returns
 
coupon_code  coupon_code
 

      always returned 
 Resource object representing coupon_code
 
Sample admin console URL
 

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