Commerce

Zuora

9min

With Zuora modules in , you can manage the queries, bill runs, invoices, products, and usage in your Zuora account.

To use the Zuora modules, you must have a Zuora account with client credentials generated. You can create an account at zuora.com and you can learn more about generating the client credentials in Zuora OAuth Client Setup.

Refer to the Zuora API documentation for a list of available endpoints.

Connect Zuora to 

To establish the connection, you must:

  1. Log in to your Zuora account, and create an OAuth Client.
  2. Copy the Client ID and Client Secret values and store them in a safe place.
  3. Log in to your account, add a Zuora module to your , and click Create a connection.
  4. Optional: In the Connection name field, enter a name for the connection.
  5. In the Region field, enter the region name for the URL to be stored in the connection. For example, if your URL is https://<region>.zuora.com, enter region.
  6. In the Client ID and Client Secret fields, enter the client credentials stored above.
  7. Click Save.
  8. If prompted, authenticate your account and confirm access.

You have successfully established the connection. You can now edit your and add more Zuora modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.

Build Zuora 

After connecting the app, you can perform the following actions:

Query

  • Run a ZOQL Query
  • Run a ZOQL Query (Select)
  • Run a ZOQL Query (Advanced)
  • Perform a Data Query
  • Submit a Data Query (Advanced)
  • Retrieve a Data Query (Advanced)

Get Data

  • Describe an Object
  • List All Custom Fields for an Object
  • Retrieve a File

Bill Runs

  • Perform a Billing Preview Run
  • Create a Billing Preview Run (Advanced)
  • Retrieve a Billing Preview Run (Advanced)
  • Retrieve a Bill Run

Invoices

  • Download an Invoice File
  • List All Files of an Invoice

Products

  • Get a Product Rate Plan Charge
  • Create a Product Rate Plan (Advanced)
  • Create a Product Rate Plan Charge (Advanced)
  • Update a Product Rate Plan Charge (Advanced)
  • Update a Product Rate Plan Charge Tier Price

Usage

  • Create a Usage Record (Advanced)
  • Update a Usage Record (Advanced)

Other

  • Run a Workflow
  • Make an API Call