Skip to content

Zuora client libraries

Zuora client libraries (also known as SDKs) make it easy for developers to start using and integrating with the Zuora REST APIs.

This section contains the installation instructions to access these libraries in several popular server-side programming languages.

For the sample codes in different use cases, see Tutorials.

Access Zuora client libraries

Java library

Maven

We provide a Java library, which you can use by adding the following dependency to the pom.xml file of your project:

pom.xml
<dependency>
    <groupId>com.zuora.sdk</groupId>
    <artifactId>zuora-sdk-java</artifactId>
    <version>$version</version>
</dependency>

Make sure to replace $version with the latest Zuora Java library version.

See Java library reference documentation for detailed classes and methods in Java client library.

Gradle

Add zuora-sdk-java to the dependencies block of your build.gradle file:

build.gradle
dependencies {
  implementation("com.zuora.sdk:zuora-sdk-java:$version")
  // ...
}

Make sure to replace $version with the latest Zuora Java library version.

See Java library reference documentation for detailed classes and methods in Java client library.

Node.js library

Install the Zuora Node.js library by running the following command:

terminal
npm i zuora-sdk-js

For more information about Zuora Node.js libraries, check Zuora JS SDK.

See Node.js library reference documentation for detailed classes and methods in Node.js client library.

Python library

Install the Zuora Python library by running the following command:

terminal
pip install zuora-sdk

For latest released versions of the Zuora Python library, check Zuora Python SDK - Release history.

See Python library reference documentation for detailed classes and methods in Python client library.

C# library

Using .NET Core CLI

Install the Zuora C# library by running the following .NET Core CLI command:

terminal
dotnet add package ZuoraSDK

Using NuGet CLI

Install the Zuora C# library by running the following NuGet CLI command:

terminal
nuget install ZuoraSDK

For more information about installing NuGet CLI, see Nuget CLI installation documentation.

Using the Package Manager Console

Install the Zuora C# library by using the Visual Studio NuGet Package Manager Console:

terminal
Install-Package ZuoraSDK

Install within the Visual Studio

You can choose to install Zuora C# client library within Visual Studio by following the steps below. For more information about installing a package within Visual Studio, see Install and manage packages in Visual Studio.

  1. Open the Solution Explorer in Visual Studio.
  2. Right-click on a project within your solution.
  3. Click Manage NuGet Packages.
  4. Click the Browse tab and search for ZuoraSDK.
  5. Select the ZuoraSDK package, then select the appropriate version in the right-tab and click Install.

For latest released versions of the Zuora C# library, check Zuora C# SDK on NuGet.

See C# library reference documentation for detailed classes and methods in the C# client library.

Limitations

Previous page
Next page