Sync between Limio Subscriptions and Zuora Subscriptions

For Limio-initiated actions such as a new order on the Limio Shop or a cancellation performed on Limio for Salesforce, Limio will make sure to have Limio subscriptions in sync with Zuora subscriptions.

However, for non-Limio-initiated actions such as a Zuora-initiated renewal, a Zuora-initiated cancel, or a new order performed via a non-Limio Salesforce application, the Limio Subscription might be out of sync with Zuora.

To prevent this, Limio Subscription has a sync feature on the Limio Subscription. The sync functionality can be used in two ways, either to:

1) Update subscriptions that already exist within Limio

2) Create new subscriptions / customer accounts in Limio for orders that were created outside of Limio (for example directly in Zuora)

Subscriptions that exist in Limio

For subscriptions that already exist in Limio, the simplest way to do this is through the Sync button within the Limio App.

This will fetch from Zuora and update:

• (1) update the term start date and end date

• (2) if there has been changes to future charges, it will update the next set of charges up until the term end date on the Schedule (and cancel old charges that are not applicable)

• (3) add / update addresses 

• (4) changes to the customer name and email

• (5) changes to the products, quantities and prices

It is also possible to follow the API-based process listed below.

Subscriptions that don't exist in Limio

The sync feature is queryable via the Limio API. It can be called to resync Limio for non-Limio-initiated changes, or to fetch new subscriptions and accounts that have been created outside of a Limio shop.

For example, it may be possible to automate this process using a Zuora Callout Notification or a Zuora Workflow to make the API calls automatically when any relevant changes are made within the Zuora platform. A Callout must be configured for any changes that will happen outside Limio but needs to be shown in self-service. For example,  Order Action Processed > RenewSubscription and Order Action Processed > CancelSubscription.

To trigger the sync process, you will need to make a POST request to the endpoint below, providing the Limio subscription ID or the reference. If syncing a subscription created in Zuora, the id value that needs to be provided is the subscription number, which will look something like A-S00000198.

The domain that should be used will be the domain of your Limio Commerce App and not your published Shop domain.

Method 1: Call POST to the following endpointwith subscription id

<your-domain>/api/plugins/zuora/sync/subscription/{id}

API calls will need to be made using an Authorization header using one of your provided public API keys.

Learn more about our API at http://developers.limio.com/.