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.

📘

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:

Entities that are not synced to Zuora

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.

Set the following roles:

1. Zuora Platform Role - API User
2. Billing Role - Zuora Billing Standard User
3. Payments Role - Zuora Payments Standard User
4. Finance Role - Zuora Finance Standard User
5. Commerce Role - Zuora Commerce Standard User
6. 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 called stigg-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.

Save the changes.

📘

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:

1. Zuora tenant - the URL of the your Zuora tenant
2. Client ID - the ID of the OAuth client that you created in the previous step
3. Client secret - the secret of the OAuth client that you created in the previous step

Confirm the integration setup by clicking on the Connect to Zuora button.

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.

Removing the integration

To remove the integration, click on the dotted menu icon and select the "Remove" action.

Confirm the action by clicking on the "Remove" button in the opened modal.