Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure a streaming API as a source

Create meters using a streaming API as a source, requiring specific platform roles for access.

You can create meters that use a streaming API as a source.

To access the streaming API, you must have one of the following platform roles:

  • Standard User role
  • API user role with the Run Meters or Configure Meters and Events permission.

For more information, see User Roles.

Table 1. Meter volume limit
API Sandbox Zuora Developer Sandbox Zuora Central Sandbox
Streaming API
  • 1MB payload size
  • 1K rows/ each API call
  • 600 API calls/ min
  • Format: MultiJson, Single JSON
  • 2M payload size
  • 5K rows/ each API call
  • 5,000 API calls/ min
  • Format: MultiJson, Single Json
  • 4M payload size
  • 10K rows/ each API call
  • 50,000 API calls/ min
  • Format: MultiJson, Single JSON

The guidelines for Zuora Central Sandbox should be followed for your Production environment.

Streaming API as a source

To create a meter with a Streaming API as the source:

  1. Create a Custom Meter.
  2. Select the Streaming API as the source. The Streaming API settings page is displayed.
  3. Enter a name for the streaming API.
  4. Click Select to select an Event Definition on the Streaming API setting page. You can create or select an existing Event Definition or import an Event Definition.
  5. Click Save to save the Streaming API source settings.

The Streaming API is configured as a source. The volume charge model with individual rate is not supported in streaming mode via the rating component.