Zuora

tap-zuora (transferwise variant)🥈

Subscription Management Platform

The tap-zuora extractor pulls data from Zuora that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-zuora extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-zuora
  3. Configure the tap-zuora settings using
    meltano config
    :
  4. meltano config tap-zuora set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-zuora test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-zuora may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-zuora settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-zuora list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API Type (api_type)

  • Environment variable: TAP_ZUORA_API_TYPE

The API type to use, e.g. REST.


Configure this setting directly using the following Meltano command:

meltano config tap-zuora set api_type [value]

European (european)

  • Environment variable: TAP_ZUORA_EUROPEAN

Whether to use a European client or not. Default, False.


Configure this setting directly using the following Meltano command:

meltano config tap-zuora set european [value]

Partner ID (partner_id)

  • Environment variable: TAP_ZUORA_PARTNER_ID

The partner ID.


Configure this setting directly using the following Meltano command:

meltano config tap-zuora set partner_id [value]

Password (password)

  • Environment variable: TAP_ZUORA_PASSWORD

Your password.


Configure this setting directly using the following Meltano command:

meltano config tap-zuora set password [value]

Sandbox (sandbox)

  • Environment variable: TAP_ZUORA_SANDBOX

Whether to use a sandbox or not. Default, False.


Configure this setting directly using the following Meltano command:

meltano config tap-zuora set sandbox [value]

Start Date (start_date)

  • Environment variable: TAP_ZUORA_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.


Configure this setting directly using the following Meltano command:

meltano config tap-zuora set start_date [value]

Username (username)

  • Environment variable: TAP_ZUORA_USERNAME

Your username.


Configure this setting directly using the following Meltano command:

meltano config tap-zuora set username [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-zuora extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-zuora

Maintenance Status

  • Maintenance Status

Repo

https://github.com/transferwise/pipelinewise-tap-zuora
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Wise

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api