Integration Options

Chargebee offers the following options to integrate the hosted checkout depending on your application/website's framework and business model.

• Hosted Pages API: recommended if you want to authenticate the user at your end, override payment-related information, handle returning users, and collect additional information.
• Drop-in Script.
• Via Payment Link.

When to use API vs. Drop-in Script

Hosted Pages API

Using Hosted Pages API to create In-app Checkout is the recommended approach when you already maintain a user-management or authentication system. It gives you control to override predefined information for a particular instance like changing the price of an item or providing additional trial period.

Benefits of using API integration:

• Allows you to manage authentication, collect additional information in your application/website.
• Allows you to override plan and add-on pricing during checkout.
• Optimize trial tenure. This allows you to customize the trial tenure based on the customer (For example, you can offer a 14-day trial to one customer, and a one month trial to another).

Here's a quick example on when you may want to choose Checkout via API over Drop-in script:

Let us assume that James runs a digital weight loss and fitness app. He wants to collect user information such as the client's height, weight, food habits, and so on along with their address, email, and store it in his database instead of Chargebee. He would still like to use Chargebee's Checkout as he does not want to get involved in the nitty-gritty details of PCI Compliance.

James can choose the API integration as this would allow him to collect additional information at his frontend and then use Chargebee's Hosted Pages API to collect the remaining information (specifically payment details for example).

To understand more about the integration and implementation of Checkout via API, read our developer documentation.

You can use hosted checkout via APIs for the below workflows:

• Checkout for new subscriptions
• Checkout for existing subscription upgrades
• Checkout for one-time purchases

Drop-in Script

Drop-in Script is a plug-in type easy to use solution that requires minimal developer help. You can easily create a checkout page by adding a script generated for the plan-item on your HTML page.

Checkout integrated using Drop-in script is Level 1 PCI compliant. Hence you need to fill in this questionnaire before integrating.

To use the Drop-in Script to integrate Checkout, follow these steps:

1. Click Settings>Configure Chargebee>Checkout and Self serve portal>Integrate with Chargebee.

2. Select the Product family, Plan, Currency, and Frequency from the drop-down list.

3. Add Addons and Charges if applicable using Add addon and Add charge options.

4. Copy the Header script and paste it within the head element of your website's HTML.
   

5. Copy the generated Checkout Button Code and hyperlink it in the subscribe button on your website's HTML. This way, when a customer clicks the subscribe button, the Checkout opens and displays the above selected parameters of plan name, frequency, addon, and so on.

You can use hosted checkout via Drop-in for the below workflows:

• Checkout for new subscriptions
• Checkout for one-time purchases

Learn more on how to integrate Checkout using Drop-in script.

Via Payment Link

When you're looking for a simple and effective way to collect payments from your customers, a payment link can be an excellent solution.

Chargebee allows you to construct a customized URL where you can pass product details along with additional customer and subscription information during checkout. The resulting Checkout URL can then be embedded into your application/website. You can also share this URL directly with the customers through email, and text messages as well.

To use the Payment Link to integrate Checkout, follow these steps:

1. Click Settings > Configure Chargebee > Checkout & Self-Serve Portal > INTEGRATE WITH CHARGEBEE > Via Payment Link

   
   
   

2. Choose the Business Entity if applicable. Learn more about multiple business entities.

3. Choose Checkout Type.

   1. If Subscription,
      1. Select the Product family, Plan, Currency, and Frequency from the drop-down list.
      2. Add Addons and Charges if applicable using Add addon and Add charge options.
      3. You can also add any parameters to pass additional information to the customer or subscription. Sample URL:

      https://honeydukes-test.chargebee.com/hosted_pages/checkout?subscription_items[item_price_id][0]=cbdemo_advanced-USD-monthly&subscription_items[quantity][0]=1&customer[first_name]=Minerva&customer[last_name]=McGonagall&subscription[cf_butterbeer_type]=Frozen Butterbeer
      

   2. If One Time Payment,
      1. Choose Currency.
      2. Add Charges if applicable using Add charge options. Sample URL:

      https://honeydukes-test.chargebee.com/hosted_pages/checkout?subscription_items[item_price_id][0]=cbdemo_setup-charge-USD&subscription_items[quantity][0]=1&customer[first_name]=Minerva&customer[last_name]=McGonagall
      

List of Supported Query Parameters

Here is an API spec of query parameters supported which can be used in the plan URL.

Module	Query Parameter
Subscription Item	subscription_items[item_price_id][{index}] subscription_items[quantity][{index}]
Coupons	coupon_ids[{index}]
Customer	All parameters in Create checkout for a new subscription endpoint can be used.  exceptions: taxability, consolidated_invoicing
Subscription	subscription[start_date]  subscription[{custom_field_name}], where {custom_field_name} is the API name of the custom field.
Billing address	All parameters in create checkout for a new subscription billing address can be used. exceptions: validation_status
Shipping Address	All parameters create checkout for a new subscription using shipping address can be used. exceptions: validation_status
Business Entity ID	business_entity_id Learn more. Note: Multiple Business Entities is in early access. Contact eap@chargebee.com to enable this feature.

You can integrate hosted checkout via Payment Link for the below workflows:

• Checkout for new subscriptions
• Checkout for one-time purchases