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 and other external systems via its Order Orchestration framework.
However, for non-Limio-initiated actions such as a Zuora-initiated auto renewal at the end of term, a Zuora-initiated cancel or suspension due to bad debt, the Limio Subscription might be out of sync with Zuora.
To prevent this, Limio Subscription has a sync feature on the Limio Subscription. The Subscription Sync is primarily designed to handle Subscriptions that already exists in Limio. For new subscription, we recommend using our sendOrder API, described below.
In this document, we will cover:
- Zuora changes that are supported via the Limio Sync for Subscriptions that exists in both systems
- How to trigger the Limio Sync from Zuora with no-code
- How to create Limio Subscriptions for new Subscriptions created directly in Zuora
Zuora changes that are supported via the Limio Sync for Subscriptions that exists in both systems
When a Limio Subscription Sync is triggered, this will fetch the following informtion from the Zuora Subscription and update the corresponding values on the Limio Subscription:
-
(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 or update addresses
-
(4) changes to the customer name and email
If you are making use of the new Catalog Sync and have carefully mapped Zuora Products and Rate Plans to matching Limio Offers or Add-Ons, then the Subscription Sync will also allow to:
- (5) changes to the products, quantities and prices
Alternatively, if you have not mapped your Zuora Products and Rate Plans to matching Limio Offers or Add-Ons, you can use Limio's Change Offer or Update Subscription API.
How to trigger the Limio Subscription Sync
From the UI
For Subscriptions that already exist in Limio, you can trigger the sync via the Sync button within the Limio App on the Limio Subscription.
Via the Subscription Sync API
The Limio Subscription Sync is available via the Limio API: https://api.limio.com/#tag/Sync-Zuora-Data.
Via Zuora
To trigger without needing to develop an integration, you can use a Zuora Callout Notification. A Zuora 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, make a POST request to the endpoint below, providing the Limio subscription ID or the reference. The domain that should be used will be the domain of your Limio Commerce app and not your published Limio Shop & Self-Service domain. Configure the Zuora Callout POST to the following endpoint with subscription id:
<your-Limio-app-domain>/api/plugins/zuora/sync/subscription/{id}
⚠️ Note that you should exclude Limio-initiated orders from the callout. For example, if Limio is the initiating source of a cancellation or renewal, you should not trigger a sync. This can be achieved either by excluding the Limio integration user in Zuora or excluding any orders with the Source being 'shop' or 'salesforce'.
For more complex logic, you may want to configure a Zuora Workflow to call out the Limio Sync API.
How to create Limio Subscriptions for new Subscriptions created directly in Zuora
Via the Limio Send Order API
If you are creating a Zuora Subscription outside of Limio Commerce or Limio for Salesforce, we would encourage you to consider Limio's Send Order API to create a new Subscription in Limio Commerce, Limio for Salesforce, Zuora and other systems such as entitlement and fulfillments that are part of Limio's Order Orchestration framework. This will guarantee that all metadata is properly distributed to the relevant systems within the architecture.
Via the Limio Sync Subscription API
If that is not possible and you need to create a subscription directly in Zuora, for example from Zuora CPQ into Zuora Billing, you can use the Subscription Sync via a callout to create a Subscription in Limio. The ID value that needs to be provided is the Zuora Subscription Number, which will look something like A-S00000198, for example:
https://{TENANT}.prod.limio.com/api/plugins/zuora/sync/subscription/A-S00000271
If you want to enable commerce actions, you will need to map your Zuora Product and Rate Plans to Limio Offers and Add-Ons as defined in the new Catalog Sync.
This Sync feature with Catalog mapping is currently in beta, so please contact support@limio.com to activate it.
Comments
0 comments
Please sign in to leave a comment.