Getting Started

Product Catalog

Customers

Subscriptions

Invoices, Credit Notes, and Quotes

Taxes

Payments

Site Configuration

Data Privacy & Security

Data Operations

Reports and Analytics

Integrations

Chargebee Actions in Salesforce 

Warning

Migration
If you are migrating your Chargebee site from Product Catalog 1.0 to 2.0 then uninstall the older version of the integration package from you Salesforce org and install package v1.41 or above. Contact [email protected]  for assistance with the installation.

Note

Add Chargebee UI elements manually
Add the following user interface elements to the Page Layouts  of the various Salesforce  objects:

  • Buttons for all Chargebee actions in Salesforce discussed on this page.
  • Custom fields introduced by Chargebee for standard Salesforce objects.
  • Chargebee custom objects to be added to related lists of Salesforce standard objects.

Editing fields on pages
If you edit fields on Salesforce pages, the changes are not synced to Chargebee. The only exception is the Account object whose data can be pushed using the Create/Update Chargebee Customer action.

Account Actions 

The actions listed in this section are those that can be performed from a Salesforce account.

Note

On carrying out any of the below-mentioned actions from an account, all the subscriptions, and invoices of the associated Chargebee customer record begin syncing to Salesforce immediately. This speeds up the availability of the subscriptions and invoices related to an account within Salesforce.

Create/Update Chargebee Customer 

Available under: Account

Description

Pushes the account information into a Chargebee customer record as explained in the Sales Driven flow. If the account has not been mapped to a customer in Chargebee then a new customer record is created in Chargebee first. You can also automate this process for any account by selecting the Sync with Chargebee checkbox on its page layout. Selecting the box immediately triggers this operation and also triggers it for every update made to the account thereafter. Clear the checkbox to stop the triggers from firing.

Note

After the first time you use the Create/Update Chargebee Customer option to update a particular Chargebee Customer, updating it thereafter overwrites the customer record in Chargebee with the new inputs from the Salesforce account even if it is more recent than that in the Salesforce account.

Note

Multiple Chargebee sites
If multiple Chargebee sites have been connected to Salesforce, then on clicking Create/Update Chargebee Customer, you will be prompted to choose one of them to sync to.

Set/View Chargebee Hierarchy 

Available under: Account

Note

Account hierarchy must be enabled in Chargebee for this action to work.

This action sets the account hierarchy in Chargebee for a pair of customers, in accordance with how it has been set for the accounts in Salesforce. If any of the pair of accounts have not been synced to Chargebee before, this action syncs them first before setting the hierarchy. You must invoke this action from the child account. If you want to set a hierarchy in Chargebee that involves multiple customer records, you must build it from the bottom, linking one parent after another.

Note

Viewing the Hierarchy

If the account hierarchy has already been set in Chargebee, the action displays the currently set hierarchy in Chargebee.

When setting the hierarchy in Chargebee as described above, you must also choose the invoice owner and payment owner for the subscriptions created for the child account. The following options are available:

  • Who do you want to invoice? Select which account should be invoiced for the subscriptions of the customer. This customer will receive the invoice for the subscription. You can choose either the child customer or any of its ancestors.
  • Who pays the Invoice? Select who should make the payment for the subscriptions of the customer. The options available here depend on what's chosen in the previous setting:
    • If the invoice owner selected is the same as the customer in question, then the payment owner can be: either the same customer or any one of its ancestors.
    • If the invoice owner selected is an ancestor of the child, the payment owner can only be set to whoever is set as the invoice owner.

Unlinking a hierarchy

If a hierarchy is already set in Chargebee you can also use this feature to unlink it.

See also

Considerations when using account hierarchy in Chargebee and Salesforce.

Add/Create Charge 

Available under: Account

Charges and quick charges are non-recurring amounts that can be added to accounts in Salesforce (customer records in Chargebee). Charges must be predefined in Chargebee's product catalog whereas quick charges are ad-hoc and not predefined in Chargebee. Both can be added directly to accounts without being associated with subscriptions.

See also

Add/Create Charge for CB Subscriptions

Follow the steps below to add charges and quick charges to an account:

  1. From an account, click the Add/Create Charge button.

  2. If the account has never been synced to Chargebee, then the Create/Update Chargebee Customer workflow kicks in automatically.

  3. Click Add Charge to add charges from the product catalog in Chargebee. A modal is displayed with the following options:

    1. Under Charge Name, select the charge.
    2. Choose a currency.
    3. You can change the Per Unit Price for the charge provided price overriding is enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    4. Enter the Quantity if applicable. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    5. Select the Service Period for this charge.
    6. Click Confirm and the charge details are displayed on the previous screen.

  4. Add as many charges as needed by repeating step 3.

  5. Click Add Quick Charge to add ad-hoc charges to the account. A dialog is displayed with the following options:

    1. Choose a currency.
    2. Enter the Amount.
    3. Select the Service Period for the quick charge.
    4. Enter a Description for the quick charge.
    5. Select the This charge is taxable checkbox to apply taxes as configured in Chargebee.
    6. Click Confirm and the quick charge details are displayed on the previous screen.

  6. Add as many quick charges as needed by repeating step 5.

  7. Click Add Coupon to apply any available coupons to the charges and quick charges.

  8. Select the Ship to billing address checkbox to auto-fill the address from the Account. Clear the checkbox to enter a shipping address that's different from the billing address.

  9. Enter the PO Number as applicable.

  10. Under Invoice Notes, add any notes that should be displayed on the invoice PDF to be sent to the customer.

  11. Click Preview and Send and a modal is shown with the preview of the invoice that would be generated.

  12. Click Create Invoice to actualize the charges and quick charges.

Update Payment Method (Email) 

Available under: Account

Sends an email via Chargebee to the account prompting them to update their payment method. The email contains a link that the customer can follow to enter their payment method details which are then stored by Chargebee for later payments.

Note

When multiple Chargebee sites are connected…
This operation will be invoked for the Chargebee site that the account has been mapped to.

Note

Using Account Hierarchy in Chargebee
If payments for the customer are made by another in Chargebee, ensure that this action is invoked in Salesforce from the account which corresponds to the paying customer.

Update Payment Method 

Available under: Account

This action allows a Salesforce user to directly update the payment method on behalf of the customer in Chargebee. The payment method is captured in a PCI DSS compliant modal or page.

Note

When multiple Chargebee sites are connected…
This operation will be invoked for the Chargebee site that the account has been mapped to.

Note

Using Account Hierarchy in Chargebee
When payments for the customer are made by another in Chargebee, ensure that this action is invoked in Salesforce from the account which corresponds to the paying customer.

Invoice Unbilled Charges 

Available under: Account

This operation is used to invoice any unbilled charges that may be present for the Chargebee customer record mapped to the account.

Note

When multiple Chargebee sites are connected…
This operation will be invoked for the Chargebee site that the account has been mapped to.

Create Subscription 

Available under: Account

This action creates a subscription against the Chargebee customer mapped to the account. Subscriptions can also be created from quotes directly by converting them.

Note

When multiple Chargebee sites are connected…
This operation will be invoked for the Chargebee site that the account has been mapped to.

  1. If the account has never been synced to Chargebee then the Create/Update Chargebee Customer workflow kicks in automatically.

  2. Choose an opportunity

    • If any open opportunities exist for the account, you can choose one of them so that it is updated with the product family (plans, addons, and charges) and coupons from the subscription. Once the subscription is created, the opportunity is updated if setting 1 and 2 are configured appropriately. If you don't choose an opportunity, the options selected under this setting 2 for opportunities and subscriptions applies.

  3. Choose a Subscription Id for the subscription. When not entered, it is auto-generated by Chargebee.

  4. Select a Product Family. The plans, addons, and charges available in the next steps depend on the product family selected.

  5. Enter the Plan Details:

    • Select a plan using the Plan Name dropdown menu. The plans shown belong to the product family selected in the previous step. Note: The plan selected can be metered, in which case the upcoming invoices for the subscription are closed manually or automatically based on the setting at the customer level and site level in Chargebee. The former takes precedence over the latter.
    • The Choose Currency field displays the opportunity currency. To change this, you must edit the Opportunity Currency field for the opportunity.
    • Select the billing frequency you want from the Choose Frequency dropdown.
    • The Price field displays the plan price for the currency and billing frequency selected. (Note: For tiered, volume and stairstep pricing models, hover over the "i" icon to reveal a tooltip showing the price split among the quantity tiers.) You can change the value provided price overriding has been enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.

  6. Enter the details for Addons:

    • Once a plan has been selected, any mandatory addons are displayed in this section automatically. They cannot be removed and their quantities cannot be changed.
    • Recommended addons for the plan also show up automatically. These can be changed or removed.
    • Click on Add Addon to select any more addons for the opportunity.
    • Select an addon under Addon Name. Note: The plan selected can be metered, in which case the upcoming invoices for the subscription are closed manually or automatically based on the setting at the customer level and site level in Chargebee. The former takes precedence over the latter.
    • Choose Frequency dropdown lists the billing frequencies of the addon that are compatible with the billing frequency selected for the plan. The plan billing frequency has to be a multiple of the addon billing frequency for the latter to be compatible with the plan.
    • By default, the price of the addon specified for the currency and billing period combination is displayed under Unit Price. If differential pricing has been enabled for the addon for the plan chosen, then that price is shown by default.
    • You can change the unit price for the addon provided price overriding has been enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    • If the pricing model is anything other than flat fee, you can input the Quantity as well. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    • If billing cycles for addons is enabled in Chargebee, you can set the number of billing cycles for the addon.
    • To remove an addon, click the Remove link seen on the right side of the addon details.

  7. Enter the details for Charges:

  8. Once a plan has been selected, any charges that have been configured to apply automatically along with it are displayed in this section.

  9. You can change the unit price for the charge provided price overriding has been enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.

  10. If the pricing model is anything other than flat fee, you can input the Quantity as well. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.

  11. Under Charge customers, select the event at which the charge should be applied to the subscription.

  12. Under Apply charges, select if you want to have the charge applied every time the event occurs or Once.

  13. Under Number of days of service provided, select the number of days of service period for the charge.

  14. To remove a charge, click the Remove link seen on the right side of the charge details.

  15. Use the Select a coupon dropdown and apply any of the coupons available. Multiple coupons can be applied.

  16. Provide the Billing details:

    1. Enter a Start Date for the subscription. The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately. If set to a value in the past then that date/time should not be more than the duration worth a plan billing period, into the past.

    2. Under Billing Cycles Type, select one of the following options:

      1. Forever: the subscription renews after the end of each term until it is explicitly canceled.
      2. Fixed: the subscription renews for a fixed number of billing cycles. In this case, provide the following additional details:
        1. Enter the number of billing cycles that the subscription should run before canceling automatically.
        2. Select the Apply contract terms to this subscription checkbox to enable contract terms. On selecting the checkbox, you are presented with options to override the default contract terms settings that have been configured for the Chargebee site.

    3. Set the Auto Collection Status for the subscription.

  17. Clear Ship to billing address checkbox to enter a shipping address that's different from the billing address. The shipping address in the Account is prefilled and you can edit as needed.

  18. Invoicing Options: When charges are raised immediately on subscription creation, the following options determine how they're handled:

    • Invoice immediately: the charges are immediately invoiced.
    • Add to Unbilled Charges: the charges are added to unbilled charges.
Note

Once the subscription is created in Chargebee, it is immediately synced back into Salesforce as a record under the CB Subscription custom object. This sync can take a few minutes. The opportunity – if one is chosen in step 3 above – is also updated.

Send Checkout Link

Note

Using Account Hierarchy in Chargebee
If the customer record linked to the contact is part of a hierarchical account relationship in Chargebee, then using this action will cause erroneous behavior. Always use the Create Subscription action for such cases.

When on the Create Subscription page, you have the alternative of enabling the customer to checkout and pay for the subscription themselves. This is done via the Send Checkout Link button.

Contract Terms

Contract terms are not created when using Send Checkout Link. To include contract terms, complete the subscription creation by clicking on Create Subscription button at the end of the form when creating a subscription from an account or opportunity.

  1. Fill in the Create Subscription form and click the Send Checkout Link button at the bottom.

  2. Edit the subject and the body of the email. Note that the checkout link is inserted into the body of the email.

  3. Click Send. Sent emails can be seen on the Activity tab for the opportunity, contact and account in Salesforce.

  4. The customer can now click on the checkout link and pay for the subscription. The shipping address specified in the Create Subscription page is prefilled for the customer on the checkout page. When the subscription is created in Chargebee on checkout, the address is attached to it.

The subscription once created, is reflected in Salesforce when the next sync is run.

Note

No offline payments
The Send Checkout Link workflow signs up the customer using Chargebee Checkout. The subscription is created once the payment is made successfully. There is no option for the customer to defer payments and make them offline later.
If you wish to keep charges unbilled for the customer then instead of using Send Checkout Link, select the Add to unbilled charges option on the Create Subscription form instead and click on Create New Subscription.

Opportunity Actions 

The actions listed in this section are those that can be performed from a Salesforce opportunity.

Manage CB Products 

Available under: Opportunity

This action is used to add Chargebee items (plan, addons, and charges) and coupons to the opportunity.

Caution
We recommend that you use Manage CB Products instead of Add Products or Edit Products  to insert Chargebee products into opportunities as the latter are incompatible with certain Chargebee features such as:

Prerequisites

  • If you have multiple currencies enabled, ensure that the Opportunity Currency field has been set to the right currency. The available options in the next steps depend on the opportunity currency.

  • The Chargebee product catalog is configured with product families, plans, addons, charges with prices set for the currencies and billing frequencies as appropriate.

  • Enable price overriding to allow users to change the price of items in the product catalog when adding or updating them in a subscription.

Opportunity for a new subscription

If the opportunity is for a new subscription, then add products as follows:

  1. From an opportunity that doesn't have a subscription attached, click on Manage CB Products.

  2. Select New Subscription from the Manage Products For dropdown.

  3. Under Family Details, select a Product Family from the dropdown. The plans, addons, and charges available in the next steps depend on the Product Family selected.

  4. Enter the Plan Details:

    • Select a plan using the Plan Name dropdown menu. The plans shown belong to the product family selected in the previous step. Note: The plan selected can be metered, in which case the upcoming invoices for the subscription are closed manually or automatically based on the setting at the customer level and site level in Chargebee. The former takes precedence over the latter.
    • The Choose Currency field displays the opportunity currency. To change this, you must edit the Opportunity Currency field for the opportunity.
    • Select the billing frequency you want from the Choose Frequency dropdown.
    • The Price field displays the plan price for the currency and billing frequency selected. You can change the value provided price overriding has been enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
      • Note: For tiered, volume and stairstep pricing models, hover over the "i" icon to reveal a tooltip showing the price split among the quantity tiers. (See screenshot below).

  5. Enter the details for Addons:

    • Once a plan has been selected, any mandatory addons are displayed in this section automatically. They cannot be removed and their quantities cannot be changed.
    • Recommended addons for the plan also show up automatically. These can be changed or removed.
    • Click on Add Addon to select any more addons for the opportunity.
    • Select an addon under Addon Name. Note: The plan selected can be metered, in which case the upcoming invoices for the subscription are closed manually or automatically based on the setting at the customer level and site level in Chargebee. The former takes precedence over the latter.
    • Choose Frequency dropdown lists the billing frequencies of the addon that are compatible with the billing frequency selected for the plan. The plan billing frequency has to be a multiple of the addon billing frequency for the latter to be compatible with the plan.
    • By default, the price of the addon specified for the currency and billing period combination is displayed under Unit Price. If differential pricing has been enabled for the addon for the plan chosen, then that price is shown by default.
    • You can change the unit price for the addon provided price overriding has been enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    • If the pricing model is anything other than flat fee, you can input the Quantity as well. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    • If billing cycles for addons is enabled in Chargebee, you can set the number of billing cycles for the addon.
    • To remove an addon, click the Remove link seen on the right side of the addon details.

  6. Enter the details for Charges:

  7. Once a plan has been selected, any charges that have been configured to apply automatically along with it are displayed in this section.

  8. You can change the unit price for the charge provided price overriding has been enabled in Chargebee. Pricing model for the charge currency is flat fee or per unit.

  9. If the pricing model is anything other than flat fee, you can input the Quantity as well. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.

  10. Under Charge customers, select the event at which the charge should be applied to the subscription.

  11. Under Apply charges, select if you want to have the charge applied every time the event occurs or Once.

  12. Under Number of days of service provided, select the number of days of service period for the charge.

  13. To remove a charge, click the Remove link seen on the right side of the charge details.

  14. Use the Select a coupon dropdown and apply any of the coupons available. Multiple coupons can be applied.

  15. Click Add Products to update the opportunity products with the details selected.

Opportunity for subscription amendment

You can amend a Chargebee subscription from Salesforce. This is typically done when offering upgrades. It is recommended that you create a new opportunity for this and not reuse the original Closed-Won opportunity that was used to create the subscription. Follow the steps below to do so:

  1. Ensure that the new opportunity belongs to the account that has the subscription. The subscriptions associated with an account can be seen in the account's CB Subscription related list.

  2. Click Manage CB Products, and select Existing Subscription under Manage Products For. All active or trialing subscriptions linked to the account are listed.

  3. Select one of the subscriptions and click Next. The form is prefilled with the plan, addons, charges, and coupons that are currently part of the subscription.

  4. Update the details on the form as required. The instructions for the New subscription workflow apply here as well.

  5. Click Update Products. The opportunity products are updated and the Subscription Id field of the opportunity is updated with the subscription Id.

Create/Change Subscription 

Available under: Opportunity

This action allows you to create/change a subscription from an opportunity. You can have this operation trigger automatically for won opportunities by using setting 3 under opportunities for Opportunities and Subscriptions.

Caution
To add/edit opportunity products before performing this action, we recommend that you use Manage CB Products instead of Add Products or Edit Products  as the latter are incompatible with certain Chargebee features such as:

Note

When multiple Chargebee sites are connected…
This operation will be invoked for the Chargebee site that the account has been mapped to.

Note

Once the subscription is created/updated in Chargebee, it is immediately synced back into Salesforce as a record under the CB Subscription custom object. This sync can take a few minutes.

Creating a new subscription

Once you have added the Product Families using the Manage CB Products option follow the steps below to create new subscriptions for your Opportunity:

  1. Click Create/Change Subscription. Any product catalog items (plans, addons, charges and coupons) that have been added to the opportunity are prefilled in the form that appears.
  2. Choose a Subscription Id for the subscription. When not entered, it is auto-generated by Chargebee.
  3. If items have not been added to the opportunity, the next steps tell you how to add them.
  4. Select a Product Family. The plans, addons, and charges available in the next steps depend on the product family selected.
    Enter the Plan Details:
    • Select a plan using the Plan Name dropdown menu. The plans shown belong to the product family selected in the previous step. Note: The plan selected can be metered, in which case the upcoming invoices for the subscription are closed manually or automatically based on the setting at the customer level and site level in Chargebee. The former takes precedence over the latter.
    • The Choose Currency field displays the opportunity currency. To change this, you must edit the Opportunity Currency field for the opportunity.
    • Select the billing frequency you want from the Choose Frequency dropdown.
    • The Price field displays the plan price for the currency and billing frequency selected. (Note: For tiered, volume, and stairstep pricing models, hover over the "i" icon to reveal a tooltip showing the price split among the quantity tiers. (See screenshot below) You can change the value provided price overriding has been enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
  5. Enter the details for Addons:
    • Once a plan has been selected, any mandatory addons are displayed in this section automatically. They cannot be removed and their quantities cannot be changed.
    • Recommended addons for the plan also show up automatically. These can be changed or removed.
    • Click on Add Addon to select any more addons for the opportunity.
    • Select an addon under Addon Name. Note: The plan selected can be metered, in which case the upcoming invoices for the subscription are closed manually or automatically based on the setting at the customer level and site level in Chargebee. The former takes precedence over the latter.
    • Choose Frequency dropdown lists the billing frequencies of the addon that are compatible with the billing frequency selected for the plan. The plan billing frequency has to be a multiple of the addon billing frequency for the latter to be compatible with the plan.
    • By default, the price of the addon specified for the currency and billing period combination is displayed under Unit Price. If differential pricing has been enabled for the addon for the plan chosen, then that price is shown by default.
    • You can change the unit price for the addon provided price overriding has been enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    • If the pricing model is anything other than flat fee, you can input the Quantity as well. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    • If billing cycles for addons is enabled in Chargebee, you can set the number of billing cycles for the addon.
    • To remove an addon, click the Remove link seen on the right side of the addon details.
  6. Enter the details for Charges:
  7. Once a plan has been selected, any charges that have been configured to apply automatically along with it are displayed in this section.
  8. You can change the unit price for the charge provided price overriding has been enabled in Chargebee.The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
  9. If the pricing model is anything other than flat fee, you can input the Quantity as well. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
  10. Under Charge customers, select the event at which the charge should be applied to the subscription.
  11. Under Apply charges, select if you want to have the charge applied every time the event occurs or Once.
  12. Under Number of days of service provided, select the number of days of service period for the charge.
  13. To remove a charge, click the Remove link seen on the right side of the charge details.
  14. Use the Select a coupon dropdown and apply any of the coupons available. Multiple coupons can be applied.
  15. Provide the Billing details:
    1. Enter a Start Date for the subscription. The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately. If set to a value in the past then that date/time should not be more than the duration worth a plan billing period, into the past.
    2. Under Billing Cycles Type, select one of the following options.
      1. Forever: the subscription renews after the end of each term until it is explicitly canceled.
      2. Fixed: the subscription renews for a fixed number of billing cycles. In this case, provide the following additional details:
        1. Enter the number of billing cycles that the subscription should run before canceling automatically.
        2. Select the Apply contract terms to this subscription checkbox to enable contract terms. On selecting the checkbox, you are presented with options to override the default contract terms settings that have been configured for the Chargebee site.
    3. Set the Auto Collection Status for the subscription.
  16. Clear Ship to billing address checkbox to enter a shipping address that's different from the billing address. The shipping address in the Account is prefilled and you can edit as needed.
  17. Invoicing Options: When charges are raised immediately on subscription creation, the following options determine how they're handled:
    • Invoice immediately: the charges are immediately invoiced.
    • Add to Unbilled Charges: the charges are added to unbilled charges.
  18. Click Create Subscription. If you'd rather have the customer subscribe themselves, click Send Checkout Link instead.

Amending an existing subscription

You can amend a Chargebee subscription from Salesforce. This is typically done when offering upgrades. It is recommended that you create a new opportunity for this and not reuse the original Closed-Won opportunity that was used to create the subscription. Follow the steps below to do so:

  1. Navigate to an opportunity that belongs to the appropriate account. The subscription you intend to change must belong to this account.

  2. Click Create/Change Subscription.

  3. Under the Create/Change Subscription for dropdown, select Existing Subscription. All the active and in-trial subscriptions that belong to the Account are listed for selection. This list includes subscriptions that haven't synced to Salesforce yet from Chargebee.

  4. Select the subscription you want to change and click Next. A page titled Change Subscription loads with all the subscription details prefilled.

  5. Make changes to the form. The instructions provided for creating a new subscription also apply here.

  6. Optionally, you can provide the Billing details to modify them:

    • Enter the No. Of Billing Cycles that the subscription should run before canceling automatically. This need only be provided if you want to change the original value.

    • Update the PO Number as needed.

  7. Under Apply Changes, select one of the following options:

    • Immediately: Apply the changes effective immediately. Optionally, also select Apply prorated charges to give prorated credits for the existing items in the subscription and raise prorated charges for the new items. Prorated charges are not applicable when the billing period of the subscription is changed, such as when moving from a monthly to a yearly plan or vice versa.

    • On next Renewal: Apply the changes on the next renewal of the subscription.

    • Invoicing Options: When charges are raised immediately on subscription change, the following options determine how they're handled:

    • Invoice immediately: the charges are immediately invoiced.

    • Add to Unbilled Charges: the charges are added to unbilled charges.

  8. Click Update to confirm the changes to the subscription.

Once the subscription is updated in Chargebee, it is immediately synced back into Salesforce. This sync can take a few minutes. Unlike when creating a subscription, a Chargebee Checkout link cannot be sent to the customer via Salesforce for changing subscriptions.

Create Quote for a New Subscription 

Available under: Opportunity

This action creates a new subscription quote for a customer in Chargebee. The opportunity must be linked to an account.

Note

When multiple Chargebee sites are connected…
This operation will be invoked for the Chargebee site that the account has been mapped to.

  1. Select a Product Family. The plans, addons, and charges available in the next steps depend on the product family selected.
  2. Enter the Plan Details:
    1. Select a plan using the Plan Name dropdown menu. The plans shown belong to the product family selected in the previous step. Note: The plan selected can be metered, in which case the upcoming invoices for the subscription are closed manually or automatically based on the setting at the customer level and site level in Chargebee. The former takes precedence over the latter.
    2. The Choose Currency field displays the opportunity currency. To change this, you must edit the Opportunity Currency field for the opportunity.
    3. Select the billing frequency you want from the Choose Frequency dropdown.
    4. The Price field displays the plan price for the currency and billing frequency selected. ( Note: For tiered, volume, and stairstep pricing models, hover over the "i" icon to reveal a tooltip showing the price split among the quantity tiers.) You can change the value provided price overriding has been enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
  3. Enter the details for Addons:
    1. Once a plan has been selected, any mandatory addons are displayed in this section automatically. They cannot be removed and their quantities cannot be changed.
    2. Recommended addons for the plan also show up automatically. These can be changed or removed.
    3. Click Add Addon to select any more addons for the quote.
    4. Select an addon under Addon Name. Note: The plan selected can be metered, in which case the upcoming invoices for the subscription are closed manually or automatically based on the setting at the customer level and site level in Chargebee. The former takes precedence over the latter.
    5. Choose Frequency dropdown lists the billing frequencies of the addon that are compatible with the billing frequency selected for the plan. The plan billing frequency has to be a multiple of the addon billing frequency for the latter to be compatible with the plan.
    6. By default, the price of the addon specified for the currency and billing period combination is displayed under Unit Price. If differential pricing has been enabled for the addon for the plan chosen, then that price is shown by default.
    7. You can change the unit price for the addon provided price overriding has been enabled in Chargebee.The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    8. If the pricing model is anything other than flat fee, you can input the Quantity as well. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    9. If billing cycles for addons is enabled in Chargebee, you can set the number of billing cycles for the addon.
    10. To remove an addon, click the Remove link seen on the right side of the addon details.
  4. Enter the details for Charges:
    1. Once a plan has been selected, any charges that have been configured to apply automatically along with it are displayed in this section.
    2. You can change the unit price for the charge provided price overriding has been enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    3. If the pricing model is anything other than flat fee, you can input the Quantity as well. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
    4. Under Charge customers, select the event at which the charge should be applied to the subscription.
    5. Under Apply charges, select if you want to have the charge applied every time the event occurs or Once.
    6. Under Number of days of service provided, select the number of days of service period for the charge.
    7. To remove a charge, click the Remove link seen on the right side of the charge details.
  5. Use the Select a coupon dropdown and apply any of the coupons available. Multiple coupons can be applied.
  6. Provide further Quote Details:
    1. Select a Billing Cycles Type:
      1. Forever: the subscription renews after the end of each term until it is explicitly canceled.
      2. Fixed: the subscription renews for a fixed number of billing cycles. In this case, provide the following additional details:
        1. Enter the number of billing cycles that the subscription should run before canceling automatically.
        2. A checkbox named Apply contract terms to this subscription appears towards the end of the form. Select it to enable contract terms. On selecting the checkbox, you are presented with options to override the default contract terms settings that have been configured for the Chargebee site.
    2. Set an Expiry Date for the quote. The quote is automatically marked closed upon expiry and can no longer be converted.
    3. Specify a subscription Start Date to initiate the subscription on a particular date in the future. If this is not configured, the subscription starts when the quote is invoiced.
    4. Add any Notes that you want to be displayed on the quote PDF for the customer's reference. You can even have a note configured in your Chargebee site to be applied to all quotes automatically. These notes are imprinted on the quote PDF and can also be seen in the Notes & Attachment related list for the quote.
    5. Select Display detailed charges on the quote PDF if you want the quote PDF to include a detailed breakdown of charges applicable in each billing cycle through the lifetime of a subscription.
  7. Clear Ship to billing address checkbox to enter a shipping address that's different from the billing address. The shipping address in the Account is prefilled and you can edit as needed.

Once created, the quote is visible under the CB Quotes related list for the opportunity.

Note

Quote line items

  • The Quote Line Items related list for CB Quote lists all the products of the quote that will be invoiced first when the quote is converted.
  • The CB Quote Products related list contains all the products that are part of the quote regardless of when they will be invoiced.

Create Quote for Subscription Amendment 

Available under: Opportunity

This action creates a quote to make changes to a subscription. This is typically done when offering upgrades. The opportunity must be linked to the account that the subscription belongs to. Use a new opportunity for this purpose and not the original Closed-Won opportunity that created the subscription. Follow the steps bellow for this:

  1. From the opportunity, click Create Quote.
  2. In the Create Quote for dropdown, select Existing Subscription. The subscriptions associated with the account that has the same currency as that of the opportunity are listed. This list includes subscriptions that haven't synced to Salesforce yet from Chargebee.
  3. Select the subscription you want to create the quote for and click Next.
  4. You will now be presented with the same page as that for creating a quote for a new subscription. The only difference is that the page is prefilled with the data from the subscription. Make changes as needed and click Create Quote.

CB Subscription Actions 

The actions listed in this section are those that can be performed from the CB Subscription custom object in Salesforce.

Change Subscription 

Available under: CB Subscription

This operation makes changes to a subscription in Chargebee through Salesforce and then syncs it back to Salesforce. You can make any combination of the following changes to a Chargebee subscription using this action:

  • Upgrade/downgrade the plan
  • Add/remove addons
  • Change the price
  • Add coupon discounts
  • Change the PO Number
  • Change the number of billing cycles


  1. Navigate to the subscription page and click Change Subscription.
  2. Update the plan, addon, charge, and coupon details as suggested in the section for Create Subscription.
  3. Optionally, you can provide the Billing details to modify them:
  4. Enter the No. Of Billing Cycles that the subscription should run before canceling automatically. This need only be provided if you want to change the original value.
  5. Update the PO Number as needed.
  6. Under Apply Changes, select one of the available options:
    • Immediately: Apply the changes effective immediately. Optionally, also select Apply prorated charges to give prorated credits for the existing items in the subscription and raise prorated charges for the new items. Prorated charges are not applicable when the billing period of the subscription is changed, such as when moving from a monthly to a yearly plan or vice versa.
    • On next Renewal: Apply the changes on the next renewal of the subscription.
    • Invoicing Options: When charges are raised immediately on subscription change, the following options determine how they're handled:
    • Invoice immediately: the charges are immediately invoiced.
    • Add to Unbilled Charges: the charges are added to unbilled charges.
  7. Click Update to confirm the changes to the subscription.
  8. Once the subscription is updated in Chargebee, it is immediately synced back into Salesforce. This sync can take a few minutes. Unlike when creating a subscription, a Chargebee Checkout link cannot be sent to the customer via Salesforce for changing subscriptions.

Cancel Subscription 

Available under: CB Subscription

This action cancels the subscription. Follow the steps below to cancel a subscription from Salesforce:

  1. Navigate to the subscription.
  2. Click Cancel Subscription.
  3. Select an option under When do you want to cancel the subscription?
    • Cancel immediately: on selecting this option, you must select an option under How do you want to handle credits for the unused period?
      • Issue full credits: Create a credit note for all charges that were incurred for the current subscription term.
      • Don't issue credits: Do not give any credits to the customer.
      • Issue prorated credits: Create a credit note with prorated credits for the unused period.
    • Cancel on a specific date: pick a date to cancel.
    • Cancel at end of term: cancel the subscription at the end of the current term.
  4. Click Cancel Now or Schedule Cancellation as applicable.

Upon canceling a subscription, the change is only reflected in Salesforce on the next sync. You cannot delete a subscription from Salesforce.

Change Next Billing 

Available under: CB Subscription

This action changes the time/date the next renewal of the subscription happens.

Proration

Choosing to prorate will raise prorated charges or credits against the customer record depending on whether the renewal date is postponed or preponed  respectively. If prorate is unchecked then no charges or credits are raised for changing the next billing date.

Further, on choosing to prorate, if charges are raised, they may be invoiced immediately or added to unbilled charges, depending on what's chosen under Invoicing Options.

See also

Change next billing date help page.

Add/Create Charge 

Available under: CB Subscription

Charges and quick charges are non-recurring amounts that can be added to CB Subscriptions in Salesforce (subscription records in Chargebee). Charges must be predefined in Chargebee's product catalog whereas quick charges are ad-hoc and not predefined in Chargebee.

See also

Add/Create Charge for an account.

Add a Charge

Follow the steps below to add a charge to a subscription:

  1. From a CB Subscription, click the Add/Create Charge button.
  2. Click on the Add Charge tab.
  3. Under Charge Name, select the charge.
  4. You can change the Per Unit Price for the charge provided price overriding is enabled in Chargebee. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
  5. Enter the Quantity if applicable. The number of decimal places you can provide is configured in Chargebee under Multi-decimal Support.
  6. Select the Service Period for this charge.
  7. Click Confirm and the charge is added to the subscription immediately. Any coupons applied to the subscription, along with credits, and excess payments available against the customer are automatically applied.

Add a Quick Charge

Follow the steps below to a quick charge to a subscription:

  1. From a CB Subscription, click on the Add/Create Charge button.
  2. Click on the Create Quick Charge tab.
  3. Enter the Amount.
  4. Select the Service Period for the quick charge.
  5. Invoicing Options: Select from among the following options to determine how invoicing of the quick charge is handled:
    • Invoice immediately: the quick charge is invoiced immediately.
    • Add to Unbilled Charges: the quick charge is added to unbilled charges.
  6. Enter a Description for the quick charge.
  7. Click Confirm and the quick charge is created for the subscription. Any coupons applied to the subscription, along with credits, and excess payments available against the customer are automatically applied.

Sync Due Invoice Count 

Available under: CB Subscription

The Sync Due Invoice Count updates the Due Invoice Count field to the current value.

The Due Invoices Count field in the CB Subscription object shows the total number of invoices that are yet unpaid against the subscription. This field, however, is not updated on any given sync unless the subscription itself has undergone a change since the last sync. So occasionally, invoices may get paid without the field getting updated automatically. Sync Due Invoice Count helps by fetching the current value of the Due Invoice Count field from Chargebee.

CB Quote Actions 

A quote in Chargebee is a document used to let a potential buyer know how much the goods or services will cost before they commit to the purchase. You can create and work with Chargebee quotes from within Salesforce. The actions listed in this section are those that can be performed from the CB Quote custom object in Salesforce.

Send Email 

Available under: CB Quote

Once a quote is created and for as long as it is open, you can send the quote to the customer so that they can review it. The Send Email option does just that. It launches an email composer with the quote PDF attached. The body of the email, by default, also has a quote acceptance link which the customer can follow to pay and subscribe themselves. The quote acceptance link can also be found in the CB Acceptance Link field of the CB Quotes object. The shipping address details used while creating the quote are prefilled for the customer on the checkout page. When the subscription is created in Chargebee on checkout, the address is attached to it.

The subscription once created, is reflected in Salesforce when the next sync is run. Also, the opportunity is updated if setting 1 and 2 are configured appropriately.

Note

Salesforce Approvals
This operation is subject to any Salesforce approval  workflows when the appropriate setting is enabled in Chargebee.

Convert Quote 

Available under: CB Quote

This operation bills the quote and completes the purchase of the items in the quote.

The charges raised can be invoiced immediately or left as unbilled charges. If you turn Auto collection on, Chargebee attempts to collect payment for any invoice that is raised for the subscription. You can also specify the Subscription Id and the PO Number for the subscription that will be created. The former is auto-generated to a random value if not specified. Once the subscription is created in Chargebee, it is synced to Salesforce during the next sync.

Extend Expiry 

Available under: CB Quote

A Chargebee quote cannot be invoiced once expired. This action extends the expiration date of an open quote.

  1. Navigate to the quote.
  2. Click on the Extend Expiry button.
  3. Select the new expiration date from the options available and click Save.

A new quote PDF is immediately generated with the updated expiration date and made available under the Notes & Attachments related list of quote.

Generate Quote PDF 

Available under: CB Quote

If you extended the expiry of a quote from Chargebee and not Salesforce, this information is reflected in Salesforce only in the next sync and the quote PDF is not regenerated. Use this action to generate a fresh copy of the quote PDF at any time.

  1. Navigate to the quote and click Generate Quote PDF.
  2. Uncheck Display detailed charges on the generated PDF to generate the quote PDF with only a summary of charges.
  3. The new PDF is seen under the Notes & Attachments related list for the quote.

Sync to Opportunity 

Available under: CB Quote

Summary

This updates the products and value of the linked opportunity with those on the quote.

Use Case

When you have created multiple quotes for an opportunity, the products and value on the opportunity match those of the last quote created. If your client decides to go with a different quote than the one last created, you can navigate that quote and invoke this action so that the opportunity shows an accurate picture of the deal.

Steps

  1. Navigate to the quote that you want to sync to an opportunity.

  2. If the quote wasn't already linked to any opportunity, then update the Opportunity field of the quote to create the link.

  3. Click Sync to Opportunity. The following message appears.

  4. Click Yes, go ahead to update the linked opportunity with the items on the quote.

Was this article helpful?
Loading…