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, the Salesforce integration package cannot be readily migrated. Contact [email protected]  to perform the migration.

Note

Add Chargebee UI elements manually
The following user interface items need to be added to the Page Layouts  of various Salesforce  objects first:

  • 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.


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.


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 is 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.


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(product-families.html) 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.
    • 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 each of the following conditions hold true:
      • Price overriding has been enabled in Chargebee.
      • Pricing model for the plan currency and frequency combination is flat fee or per unit.
      • 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.
    • 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 each of the following conditions hold true:
    • If the pricing model is anything other than flat fee, you can input the Quantity as well.
    • 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 each of the following conditions hold true:

  9. If the pricing model is anything other than flat fee, you can input the Quantity as well.

  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.


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.
    • 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 each of the following conditions hold true:
      • Price overriding has been enabled in Chargebee.
      • Pricing model for the plan currency and frequency combination is flat fee or per unit.
      • 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).
  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.
    • 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 each of the following conditions hold true:
    • If the pricing model is anything other than flat fee, you can input the Quantity as well.
    • 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 each of the following conditions hold true:

  10. If the pricing model is anything other than flat fee, you can input the Quantity as well.

  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:

    • 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.
    • Enter the No. Of Billing Cycles that the subscription should run before canceling automatically. When not provided, the the billing cycles set for the plan price point is used.
    • Set the Auto Collection Status for the subscription.
  17. 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.

  18. 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.

  19. 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.

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.

  1. Fill 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.


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.
    • 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 each of the following conditions hold true:
      • Price overriding has been enabled in Chargebee.
      • Pricing model for the plan currency and frequency combination is flat fee or per unit.
      • 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.
    • 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 each of the following conditions hold true:
    • If the pricing model is anything other than flat fee, you can input the Quantity as well.
    • 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 each of the following conditions hold true:
  9. If the pricing model is anything other than flat fee, you can input the Quantity as well.
  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:
    • 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.
    • Enter the No. Of Billing Cycles that the subscription should run before canceling automatically. When not provided, the the billing cycles set for the plan price point is used.
    • Set the Auto Collection Status for the subscription.
  16. 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.
  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.
  19. Click Create Subscription. If you'd rather have the customer subscribe themselves, click Send Checkout Link instead.

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 advanced 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

Add Charge 

Available under: CB Subscription

This action adds a one-time charge to the subscription. This option can be quite useful, especially when you come across scenarios where you have to collect payments from customers for goods or services that are not normally included as a part of their subscription model.


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.


Was this article helpful?
Loading…