Zuora Sandbox API Configuration

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "zuora",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "config": {
    "sync_mode": "ZuoraBilling | ZuoraRevenue | Both",
    "password": "string",
    "environment": "string",
    "api_role": "For example, Integration, Admin",
    "is_multi_entity_feature_enabled": true,
    "client_secret": "zuora_client_secret",
    "entity_id": "zuora_entity_id",
    "client_name": "string",
    "client_id": "zuora_client_id",
    "host_name": "https://yourcompany.zuora.com",
    "username": "string",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`sync_mode`	Select `Zuora Billing` to sync exclusively Zuora Billing related records. Choose `Zuora Revenue` for syncing only Zuora Revenue reports. If both Zuora Billing records and Zuora Revenue reports are to be synced, opt for `Both`.
`password`	The corresponding password for the API user.
`environment`	Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
`api_role`	The API role assigned to the integration user.
`is_multi_entity_feature_enabled`	Set to `true` if there are multiple entities in your Zuora account and you only want to use one entity. Otherwise, set to `false`.
`client_secret`	Zuora Client Secret.
`entity_id`	If `is_multi_entity_feature_enabled` is `true`, then it's `EntityId`.
`client_name`	The name of your organization as registered with Zuora Revenue.
`client_id`	Zuora Client ID.
`host_name`	The domain or URL of your Zuora Revenue instance.
`username`	The API username with the necessary access permissions.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the client_id and client_secret parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "zuora",
  "group_id": "group_id",
  "config": {
    "client_id": "zuora_client_id",
    "client_secret": "zuora_client_secret"
  }
}

By using the Connect Card or the Fivetran dashboard.