Zuora

This documentation for the Zuora integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Zuora, visit our connection instructions.

Version

This integration utilizes the Zuora REST API v1.

Base URL

The base URL used for all Zuora API endpoints contains the Data Center:

https://rest.datacenter.zuora.com/v1

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
POST	https://rest.datacenter.zuora.com/oauth/token	Get and refresh access token

---

Authentication & Authorization

The DataGrail Zuora integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to Zuora API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

---

Limits

Limits in Zuora are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's Zuora integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search for contacts using configured identifiers.
2. For each of the collected accounts:
   • Retrieve contact details.
   • Fetch related account IDs from the contact details.
3. For each of the collected account IDs:
   • Retrieve basic information about a customer account.
   • Retrieve all subscriptions associated with the specified account.
   • Retrieve the information about all payments associated with the specified account.
   • Retrieve usage details for the specified customer account.
   • Retrieve the information about all refunds associated with the specified account.
   • Retrieve detailed information about all orders for a specified invoice owner.
   • Retrieve all invoices for the specified account.
   • Retrieve all credit memos for the specified account.
   • Retrieve all debit memos for the specified account.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/accounts/account_id	Retrieve an account
POST	/action/query	Search for contacts
GET	/creditmemos	List credit memos
GET	/debitmemos	List debit memos
GET	/object/contact/contact_id	Retrieve contact details
GET	/orders/invoiceOwner/account_id	List orders of an invoice owner
GET	/payment-methods/credit-cards/accounts/account_id	List all credit card payment methods
GET	/payments	List payments
GET	/refunds	List refunds
GET	/subscriptions/accounts/account_id	List subscriptions
GET	/transactions/invoices/accounts/account_id	List all invoices for an account
GET	/usage/accounts/account_id	Retrieve a usage record

---

Deletion

DataGrail's Zuora integration provides Synchronous Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Delete a contact.
2. Scrub sensitive data of a contact if deletion is not allowed.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
PUT	/contacts/id/scrub	Scrub a contact
DEL	/object/contact/contact_id	Delete a contact

---