How do I set up a hosted payment link with a coupon in Chargebee?

Related Scenarios

• How to automatically apply a coupon to a hosted payment link in Chargebee?
• Configuring Chargebee hosted pages to include discounts via coupons.

Solution

To set up a hosted payment link in Chargebee that automatically applies a coupon, use Chargebee's Hosted Pages API. Configure the payment link with the relevant parameters to include your coupon code. Here's how you can do this:

1. Access the Hosted Pages API
   Make sure you have access to the Chargebee Hosted Pages API. You'll need to generate API keys in Chargebee. To do this, go to Settings > Configure Chargebee > API Keys.

2. Create the Hosted Payment Link
   Use the POST /hosted_pages/checkout_new_for_items endpoint. Add the coupon_ids[] parameter to apply one or more coupons automatically.

Example cURL command:

curl https://{site}.chargebee.com/api/v2/hosted_pages/checkout_new_for_items \
  -u {site_api_key}: \
  -d subscription_items[item_price_id][0]="basic-USD" \
  -d subscription_items[quantity][0]="1" \
  -d coupon_ids[0]="YOUR_COUPON_ID" \
  -d customer[email]="customer@example.com" \
  -d redirect_url="https://yourdomain.com/thankyou"

• Replace {site}, {site_api_key}, basic-USD, YOUR_COUPON_ID, and other placeholder values with your actual site details, product IDs, and coupon code.
• After a successful API call, you’ll receive a hosted payment link, such as https://foobar-test.chargebee.com/pages/v3/w5zxKUSNNatl0xOJAaryn40wcTZcdhFCh/.

A sample checkout page after applying a coupon looks like this:

3. Test the Payment Link
   Before sharing the link with customers, test it to make sure the coupon is applied correctly. Open the link in your browser and verify the discount appears during the checkout process.