Getting Started

Building Blocks

Custom Fields

Subscription Features

Localization

Invoices

Credits

Order Management

Billing Features

Taxes

Payment Methods

Direct Debit Payments

Configuring Gateways

Revenue Recovery

Chargebee Moments(Checkout and Portal)

Notifications

Reports and Analytics

Data Privacy & Security

Fraud Management

Migration

Open Source Resources

Other Features

API Integration

Third Party Integrations

Salesforce: Chargebee Actions 

Note

Add buttons and fields manually

  • Add these buttons manually  to the relevant page layouts to be able to use them.
  • Also, any custom fields must also be added to page layouts manually.

Editing fields on pages
If you edit fields on Salesforce page layouts, the changes are not synced to Chargebee. The only exception is the Contact object whose data can be pushed using the Sync Customer with Chargebee action.

Sync Customer with Chargebee 

Available under: Contact

Description

Copies information from the contact fields to the mapped fields in the Chargebee customer record.

  • If the contact has not been mapped to a customer in Chargebee then:

    • a new customer record is created in Chargebee with the details from the contact.
    • if multiple Chargebee sites have been connected, you can choose one of them to sync to and a new customer record is created in that site.
  • If the contact is already mapped to a customer in Chargebee then:

    • this action overwrites information from the contact fields to the mapped customer fields. If customized field mapping has been set-up, then data is pushed in the direction configured.
    • observe caution as data is overwritten for the customer record in Chargebee even if it is more recent than that in the Salesforce contact.
    • if multiple Chargebee sites have been connected to Salesforce, then you can choose one of them to sync to. The Chargebee customer record will get created or updated depending on whether the contact has already been mapped to the site or not.

Specifying the Chargebee Customer ID

Information

Availability
This feature is only available as of package v1.18.

The Customer ID is used to uniquely identify a Customer in Chargebee. Whenever a customer record is created in Chargebee, this field must be set to a unique value. If not specified by the user, this value is set by Chargebee automatically.

When you use Sync Customer with Chargebee to push a Contact from Salesforce to Chargebee, there is no option to push the Chargebee customer ID by default. However, the integration can be configured so that this value is taken from any contact field of your choice.

Here's how:

  1. Make a note of the API name of the contact field that you wish to push into Chargebee as the customer ID.
  2. Contact support@chargebee.com  and provide this API name.
  3. Once Chargebee Support has made the changes, whenever Sync Customer with Chargebee is invoked for an unsynced contact, the value in the field will be set for the customer ID field in Chargebee.
Note

Once synced, the customer ID is unchangeable in Chargebee.

Update Payment Method (Email) 

Available under: Contact

Description:

Sends an email via Chargebee to the contact 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.

Note

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

Note

Known issue
This action fails with an error when the Chargebee site uses modal-based checkout (aka hosted pages v3). However, this can be resolved with Chargebee Support's intervention. Contact support@chargebee.com .

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 contact which corresponds to the paying customer.

Update Payment Method 

Available under: Contact

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, enabling you in meeting such compliance needs.

Note

When multiple Chargebee sites are connected…
This operation will be invoked for the Chargebee site that the contact 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 contact which corresponds to the paying customer.

Invoice Unbilled Charges 

Available under: Contact

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

Note

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

Create Subscription 

Available under: Account, Contact, Opportunity

This action creates a subscription in Chargebee against a specific customer (determined via the contact chosen).

Note

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

Note

Once the subscription is created in Chargebee, it is immediately synced into Salesforce.

Let's look at the details for when the action is invoked from the various objects:

From Account

  1. Choose one from the contacts linked to the account.

  2. If the contact has never been synced to Chargebee then the Sync Customer with Chargebee workflow kicks in automatically. This is shown below for an integration with multiple Chargebee sites connected to the Salesforce org:

  3. The plans, addons and coupons are fetched from the Chargebee site and made available.

  4. You can also choose an opportunity to be updated with the new subscription details.

From Contact

  1. If the contact has never been synced to Chargebee then the Sync Customer with Chargebee workflow kicks in automatically. This is shown below for an integration with multiple Chargebee sites connected to the Salesforce org:

  2. The plans, addons and coupons are fetched from the Chargebee site and made available.

  3. You can also choose an opportunity to be updated with the new subscription details.

Note

Opportunity handling
If you don't choose an opportunity while creating a subscription from an account or a contact, the opportunity handling falls back to what has been configured for when creating a subscription.

From Opportunity

  1. If the opportunity hasn't been linked to an account, it must be first.
  2. Once an account is linked, the action takes you through the same workflow as when creating a subscription from the linked account.

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.

  1. Fill the create subscription form and click the Send Checkout Link button.

  2. Edit the subject and the body of the email. Note that the body is split at the spot where the checkout link will be inserted.

  3. Click Send.

  4. The customer can now click on the checkout link and pay for the subscription. This creates the subscription in Chargebee which only syncs back to Salesforce on the next sync.

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 to make an offline payment later.
If you wish to keep charges unbilled for the customer then select the Add to unbilled charges option on the Create Subscription form instead and click on Create New Subscription.

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

Furthermore, these changes can be applied immediately or on the next renewal. When changes are applied immediately, you can choose whether or not to raise any prorated charges/credits for them. Moreover, when charges are raised for the changes, they can either be invoiced immediately or added to unbilled charges.

Note
  • Once the subscription is updated in Chargebee, the changes are immediately synced to Salesforce.
  • Unlike when creating a subscription, a Chargebee Checkout link cannot be sent to the customer via Salesforce for changing subscriptions.
  • See opportunity handling to see how opportunities are affected when a subscription is changed.

Cancel Subscription 

Available under: CB Subscription

This action cancels the subscription.

Subscription can be canceled immediately or at the end of the current term.

Note

Cancellation impacts
While canceling subscriptions, considerations such as whether to raise prorated credits for the unused period or how unbilled charges are handled, are dealt with as per the subscription cancellation settings configured for the Chargebee site.

Note

Upon canceling a subscription, the change is only reflected in Salesforce on the next sync and not immediately.

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.

See also

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. Sync Due Invoice Count thus fetches the current value of the Due Invoice Count field from Chargebee even it hasn't been updated on the last sync.


Was this article helpful?
Loading…