Installation

Please be aware that our Salesforce V3 is currently in Beta status and is available on request. Please contact Support@chargify.com for more information on this integration.

Installation

Install the Application Package

Click on the Salesforce package link and login to the target environment and Select ‘Install for Admins Only’.

Please note: Salesforce System Administrator Permissions Required

Click on the ‘Install’ button and installation will begin.

Once completed, you can verify if the package is installed, by navigating to Setup -> Installed Packages.

Assign Permission Sets

There are two permission sets which can be assigned.

Chargify Admin: This permission set should only be assigned to those who will modify the configuration of the integration. Chargify Admin permission set includes all of the permissions of the Chargify User, so there is no need to assign both to Admin users.


Chargify User: This permission set should be assigned to all other users of the integration.

Add Remote Site Settings for Your Chargify Sites

  1. Navigate to Setup -> Remote Site Settings

  2. For each Chargify Site you want to connect with Salesforce, create a new remote site settings record by clicking the New Remote Site button.

  3. For each remote site record, populate:

    • Remote Site Name: This can be any name you wish to use.
    • Remote Site URL: This is the URL of the Chargify site. The full URL, including https://
    • Active: Ensure this is selected.
    • Once each are populated, click ‘Save’ to save the settings for that remote site.

Connecting the integration to a Chargify site

  1. Login to your Salesforce environment as the Admin user (the one with Chargify Admin permission set assigned previously)

  2. Navigate to the “Chargify” app via the Salesforce App Manager


  3. Click on the “Chargify Configuration” tab
    NOTE: The integration is disabled by default. You must complete the following configuration steps before enabling the integration.

  4. Add Chargify Site

  5. Click on the ‘Add New Site’ button.

  6. Enter the Chargify Site Name, which is the domain of the Chargify site. Only the subdomain.chargify.com will be used here. Please remove the https:// from the site.

  7. Add your API key. This is generated in the Chargify App by navigating to Config -> Integrations -> API Keys

  8. Click ‘Save’.

Configuring data synchronization options

Please review the configuration options and make necessary changes before clicking “Turn On Integration”. These settings will determine sync timings as well as what is synced between Chargify and Salesforce.

A few things to note how the sync works. The batch sync setting below will determine when data is pulled by Salesforce from Chargify using our API using the batch job timing setup in configuration. Any changes in Salesforce will immediately be synced over to Chargify.

NOTE: The settings are pre-configured for you, and you can keep defaults. But you do have the option to change settings to meet your workflow needs.

Batch sync timing options

In this section of the configuration you are able to change the sync timing. This timing is when Salesforce will pull new data over from Chargify.

Customer sync options

Customer Configuration settings will dictate what customer information is synced between Salesforce and Chargify. The Customer ID is required and the ultimate matching ID. First the integration is going to search for matching Customer ID, if not found then will search Reference ID, if not found, then search by email.

Of course if you opt out from matching by Reference or email, this step will be skipped. When a match using Reference or Email is found, the system populates Customer ID. From now on, the match is established and the system will not try to match by Reference or Email.

Synchronization direction-

Choose the direction of synchronization between Chargify and Salesforce. If both ways are chosen Chargify and Salesforce can be used to update Customer information and the sync will update the other apps information.

If Sync from Chargify to Salesforce is chosen any updates in Salesforce will not be synced to Chargify. Updates in Chargify will be synced to Salesforce. This setting is helpful if separate Account/Contact names are used between Salesforce and Chargify. This will prevent names and information from being overwritten in Chargify.

Scope-

Choose the scope of synchronization between Chargify and Salesforce.

  • All Accounts with respective primary Contact will be synced to Chargify as a Customer. This setting will allow for Subscriptions to be created later with that information.

  • Only Accounts with Subscription will be synced. Selecting this will only synchronize Accounts that have a Subscription attached. This is helpful as only Accounts that have a customer in a Trialing or Paid subscription will be updated making it easier for users to manage customers with live subscriptions.

  • Only Accounts marked “Sync to Chargify” will be synced to Chargify (please note, that every Customer received from Chargify will be automatically marked as “Sync to Chargify”). This option is handy if Accounts/Contacts need to be selectively synced. This setting can be found when editing a Contact.

Match Customers by:

Choose how to match Salesforce accounts and contacts with Chargify customers. Matching by customer Id is defaulted and cannot be unchecked.

  • Customer ID is the ultimate matching Id between Chargify and Salesforce. This will always be used first.

  • Reference ID will use unique IDs used between Chargify and Salesforce to determine if the customer is already existing.

  • Emails can also be used to match Accounts/Contacts and Customers between Chargify and Salesforce.

Match Found behavior:

  • Override all fields- default option is set to update data each time a change is identified and a match is found.

  • Populate only empty fields- when the match is found the system will populate only empty fields, leaving the existing data unchanged.

  • Do not update any information (except Customer Id)- no updates are made when a match is found. A new Account will be created in SF when there is no match found, but the updates are turned off.

No Match Found behavior:

  • This option determines what occurs when no Match between Chargify and Salesforce is found. Either an Account will be created if no match is found between Chargify and Salesforce or alternatively this can also be set to not create a new account.

Customer Hierarchy:

  • Only one option supported. Checking with will allow for Chargify customer hierarchies to be synced over

Batch size for Customer:

  • Batch size for Customer. Entry value between 1-2000

Product Catalog sync options

  • Product Sync Direction- Sync products from Chargify to Salesforce. Currently only one option is available.

  • Sync Scope- Sync all Products from Chargify to your Salesforce price book.

  • Matching options- Allows for product matching based on API Handle or Product ID. Helpful if other integrations are using another one or the other.

  • Batch size for Product- Batch size for Product. Entry value between 1-2000.

Subscription sync options

  • Sync Scope- Sync both ways- Selecting this option will allow for sync both ways.

  • Sync Scope- All subscription- When selected all subscriptions will be synced.

  • Opportunity Closed/Won option- Options for how Opportunities are handled after being Closed or Won. Create Subscription when Opportunity is Closed/Won.Block closing opportunity without Payment Method.

  • Batch size for Subscription- Batch size for Subscription. Entry value between 1-2000.

Transactions Configuration options

  • Transactions sync status- When enabled transaction status will be displayed.
  • Transactions Sync Direction- Chargify to Salesforce
  • Retention period in months- Maximum age of the Transactions to synchronize in months. Records older than retention period will be removed to save the cloud storage.
  • Batch size for Transactions- Batch size for Transactions. Entry value between 1-2000.
  • Transaction types- When moved into the Selected column these transactions will be displayed in Salesforce. Transactions that can be displayed are: Charge, Credit, Adjustment, Payment, Refund.

Enable the Integration

After the desired sync options are selected you can now turn on your sync. To do this click the “Turn ON integration” button to enable the integration. The status change to “ENABLED” and a “Turn OFF integration” button is now present, which can be used to disable the integration if needed.

  1. Select the timeframe in which you want incremental batch data syncs to run.

  2. Select ‘Alternate Batch Processing’ when installing for testing purposes to avoid Salesforce non-production environments limitations

  3. Click ‘Save’

Configure Your Salesforce Layouts

The final installation steps are to configure the layouts for your Salesforce - Chargify views by adding the Chargify action buttons and fields which you want to have in your Chargify - Salesforce integration.

The following are recommended steps, but you can decide to add or not add fields and buttons per your workflow requirements.

Setup ‘Account’ Layout

  1. Navigate to the Salesforce Object Manager from the Setup screen.

  2. Select ‘Account’ and navigate to the layout configuration tool via Page Layouts -> Account Layout.

  3. Create a ‘Chargify’ section in the Accounts Layout

  4. Click on the ‘Section’ button from the Fields view

  5. Drag the new section into the page layout and name the section ‘Chargify’.

  6. Select and place the fields you want into the Chargify section.

  7. Change the selection view from ‘Fields’ to ‘Buttons’.

  8. Drag the ‘Create Subscription’ button to Custom Buttons in the Account Details section of the layout.

  9. Change the selection view from ‘Buttons’ to ‘Mobile & Lightning Actions’.

  10. Drag the ‘Create Subscription’ button to the Salesforce Mobile and Lightning Experience Actions section of the layout.

  11. Change the selection view from ‘Buttons’ to ‘Related Lists’.

  12. Drag ‘Chargify Subscriptions’ to the lists section of the layout.

  13. Drag the ‘Chargify Subscriptions’ to the lists section of the layout.

  14. Click ‘Save’.

Setup ‘Contact’ Layout

  1. Navigate to the Salesforce Object Manager from the Setup screen.
  2. Select ‘Contact’.
  3. Navigate to the layout configuration tool via Page Layouts -> Contact Layout.
  4. Create a ‘Chargify’ section in the Contact Layout.
  5. Click on the ‘Section’ button from the Fields view.
  6. Drag the new section into the page layout and name the section ‘Chargify’.
  7. Select and place the fields you want into the Chargify section.
  8. Change the selection view from ‘Fields’ to ‘Buttons’.
  9. Drag the ‘Create Subscription’ button to Custom Buttons in the Contact Details section of the layout.
  10. Change the selection view from ‘Buttons’ to ‘Mobile & Lightning Actions’.
  11. Drag the ‘Create Subscription’ button to the Salesforce Mobile and Lightning Experience Actions section of the layout.
  12. Change the selection view from Mobile & Lightning Actions to ‘Related Lists’
  13. Drag ‘Chargify Subscriptions’ to the lists section of the layout.
  14. Drag the ‘Chargify Subscriptions’ to the lists section of the layout.
  15. Click ‘Save’.

Setup ‘Product’ Layout

  1. Navigate to the Salesforce Object Manager from the Setup screen.

  2. Select ‘Product’.

  3. Navigate to the layout configuration tool via Page Layouts -> Product Layout.

  4. Create a ‘Chargify’ section in the Product Layout.

  5. Click on the ‘Section’ button from the Fields view.

  6. Drag the new section into the page layout and name the section ‘Chargify’.

  7. Select and place the fields you want into the Chargify section.

  8. Change the selection view from ‘Fields’ to ‘Related Lists’.

  9. Drag ‘Chargify Subscriptions’ to the lists section of the layout.

  10. Drag the ‘Chargify Subscriptions Preview’ to the lists section of the layout.

  11. Click ‘Save’.

Setup ‘Opportunity’ Layout

  1. Navigate to the Salesforce Object Manager from the Setup screen.

  2. Select ‘Opportunity’.

  3. Navigate to the layout configuration tool via Page Layouts -> Opportunity Layout.

  4. Change the selection view from ‘Fields’ to ‘Buttons’.

  5. Drag the ‘New Subscription’ button to Custom Buttons in the Opportunity Detail section of the layout.

  6. Change the selection view from ‘Buttons’ to ‘Mobile & Lightning Actions’.

  7. Drag the ‘New Subscription’ button to the Salesforce Mobile and Lightning Experience Actions section of the layout.

  8. Change the selection view from ‘Fields’ to ‘Related Lists’.

  9. Drag ‘Chargify Subscriptions’ to the lists section of the layout.

  10. Drag the ‘Chargify Subscriptions Previews’ to the lists section of the layout.

  11. Click ‘Save’.

Setup ‘Opportunity Product’ Layout

  1. Navigate to the Salesforce Object Manager from the Setup screen.
  2. Select ‘Opportunity Product’.
  3. Navigate to the layout configuration tool via Page Layouts -> Opportunity Product Layout.
  4. Drag a new section into the page layout and name the section ‘Chargify’.
  5. Drag the Chargify Subscription Preview field into the Opportunity Product Detail section that was just created.
  6. Click ‘Save’.