Zuora
Overview
Zuora is a leading subscription management & billing solution.
Stigg’s native integration with Zuora enables automatic propagation of changes from the Stigg platform to Zuora, including: changes to the product catalog (product, plans and add-ons, coupons), customers, subscriptions and their usage.
In the opened screen, click on Manage Users.
Create a new user that will be used for the integration with Stigg.
Set the following roles:
Click Save.
You should receive an email with instructions on how to activate the user.
Follow the instructions to the activate it.
In the opened modal, copy the client ID and secret - you will need to enter them in the Stigg app.
In the opened screen, select Manage Custom Fields.
Add the following custom fields to the relevant Zuora entities.
Save the changes.
Stigg’s native integration with Zuora is currently available in beta for customers of the Growth and Scale plans. See Stigg’s pricing for more details.
Entity mapping
Stigg entities are mapped to Zuora entities as follows:| Stigg Entity | Zuora Entity |
|---|---|
| Feature | N/A |
| Product | N/A |
| Plan | Product |
| Add-on | Product |
| Plan / add-on billing period | Rate Plan |
| Plan / add-on charge | Rate Plan Charge |
| Customer | Account |
| Subscription | Subscription |
Entities that are not synced to Zuora
| Entity | Not synced to Zuora when… |
|---|---|
| Customer | Customer doesn’t have any subscription |
| Customer only has subscriptions to free plans | |
| Customer only has trial subscriptions | |
| Customer only has subscriptions to plans with a custom price | |
| Customer’s billing information is not sent to Stigg | |
| Customer doesn’t have a payment method | |
| Syncing of customers is disabled in the environment | |
| Subscription | Subscription is for a free plan |
| Subscription is for a trial plan | |
| Subscription is for a plan with a custom price | |
| Syncing of subscriptions is disabled in the environment |
Syncing customer usage to Zuora
When customers are subscribed to plans with pay-as-you-go pricing, feature usage that’s reported to Stigg is synced to Zuora every hour. When the integration is enabled, it’s possible to manually trigger this sync from the Stigg app by leveraging the “Sync usage to Zuora” action in details screen of the relevant subscription.Setting up the integration
Create an API user in Zuora
In Zuora, under the Settings section click on Administration
In the opened screen, click on Manage Users.
Create a new user that will be used for the integration with Stigg.
A valid email address is required for activation of the Zuora user.
- Zuora Platform Role - API User
- Billing Role - Zuora Billing Standard User
- Payments Role - Zuora Payments Standard User
- Finance Role - Zuora Finance Standard User
- Commerce Role - Zuora Commerce Standard User
- Reporting Role - Zuora Reporting Standard User
Click Save.
You should receive an email with instructions on how to activate the user.
Follow the instructions to the activate it.
Create an OAuth client in Zuora
In Zuora, open the user that was created and activated in the previous step. Under the OAuth Clients section, create a new client calledstigg-api.
In the opened modal, copy the client ID and secret - you will need to enter them in the Stigg app.
Once closed, the client secret will no longer be shown. To view it again, you will need to create a new OAuth client.
Map Stigg metadata to Zuora custom fields
In Zuora, under the Settings section click on Billing
In the opened screen, select Manage Custom Fields.
Add the following custom fields to the relevant Zuora entities.
You can add up to 10 indexed custom and 40 non-indexed fields in Zuora. If possible, it’s recommended to add the custom fields as indexed fields.
| Zuora entity | Field type | Field label | API name | Length |
|---|---|---|---|---|
| Product | text | stiggEntityUrl | stiggEntityUrl | 255 |
| Account | text | stiggEntityUrl | stiggEntityUrl | 255 |
| Account | text | stiggCustomerId | stiggCustomerId | 255 |
| Subscription | text | stiggEntityUrl | stiggEntityUrl | 255 |
| Subscription | text | stiggCustomerId | stiggCustomerId | 255 |
| Subscription | text | stiggResourceId | stiggResourceId | 255 |
Zuora automatically adds a ‘__c’ suffix to all API names, for example: stiggEntityUrl__c
Connect Stigg with Zuora
In the Stigg app, navigate to the Settings > Integrations > Apps section. Select the Zuora integration app. In the opened form, enter the following information:- Zuora tenant - the URL of the your Zuora tenant
- Client ID - the ID of the OAuth client that you created in the previous step
- Client secret - the secret of the OAuth client that you created in the previous step
Indication for synced entities
Entities that are synced from Stigg to Zuora have a clickable “billing ID” property with a Zuora logo next to it and indication of their sync status (successful, failed, will not be synced).
Accessing Zuora entities from Stigg
In the Stigg app, clicking on the link of the “billing ID” property will open the relevant entity in Zuora.