> This page is for Developers.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://zuora.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server.

# Export details of a specific meter

GET https://rest.test.zuora.com/meters/export/{meterId}

The Export Meter operation exports the full definition of a specific meter in Zuora Mediation, including metadata, all versions, event schemas, and operator configurations (source, processor, sink). It's useful for reviewing, backing up, or replicating meter setups across environments.


Reference: https://zuora.ferndocs.com/developers/api-reference/zuora-api/mediation/meters/export-specific-meter

## Authentication

- `Authorization` header (bearer token, required) — Use `Bearer {{token}}` in the `Authorization` header for authentication.

## Servers

- `https://rest.test.zuora.com` (US Developer & Central Sandbox (incl. Test Drive), default)
- `https://rest.sandbox.na.zuora.com` (US API Sandbox Cloud 1)
- `https://rest.apisandbox.zuora.com` (US API Sandbox Cloud 2)
- `https://rest.na.zuora.com` (US Production Cloud 1)
- `https://rest.zuora.com` (US Production Cloud 2)
- `https://rest.test.eu.zuora.com` (EU Developer & Central Sandbox)
- `https://rest.sandbox.eu.zuora.com` (EU API Sandbox)
- `https://rest.eu.zuora.com` (EU Production)
- `https://rest.test.ap.zuora.com` (APAC Developer & Central Sandbox)
- `https://rest.ap.zuora.com` (APAC Production)

## Request

### Path parameters

- `meterId` (string, required) — ID of the meter to export.

### Headers

- `Accept-Encoding` (string, optional) — Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.
- `Content-Encoding` (string, optional) — Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.
- `Zuora-Entity-Ids` (string, optional) — An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.
- `Zuora-Org-Ids` (string, optional) — Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.
- `Zuora-Track-Id` (string, optional) — A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).

## Response

### 200

Successful response with meter export data

- `name` (string, optional) — Meter name
- `description` (string, optional) — Meter description
- `type` (string, optional) — Meter type (e.g., CUSTOM, STANDARD)
- `typeDefinition` (MeterTypeDefinition, optional) — The meter definition for non-CUSTOM meters
- `latestVersion` (string, optional) — The latest version of the meter
- `versions` (list of MeterVersionExportResult, optional) — List of all versions for the meter
- `schemas` (list of EventSchemaExportResult, optional) — List of event schemas used by this meter

## Errors

### 400 Bad Request Error

Bad Request

- `errors` (list of ProxyBadRequestResponseErrorsItems, optional)
- `success` (boolean, optional)

### 404 Not Found Error

Meter not found

- `success` (boolean, optional) — Whether the API request has succeeded or not.
- `data` (MediationErrorResponseData, optional) — Detailed response information for successful requests (e.g., instance info, job details).
- `error` (MediationErrorResponseError, optional) — Contains error details when the request fails.

### 500 Internal Server Error

Internal Server Error

- `reasons` (list of ErrorResponseReasonsItems, optional)

## Types

### MeterTypeDefinition

- `sourceType` (string, optional) — Source type, e.g., ZUORA_BULK_API or LOCAL_FILE
- `schemaId` (string, optional) — Event definition ID
- `fieldMappings` (list of UsageFieldMapping, optional) — Field mappings from event definition to Zuora usage
- `configs` (map from string to any, optional) — Configurations for accumulated meters (e.g., SUM)

### MeterVersionExportResult

- `version` (string, optional) — The initial version of meter, default is 0.0.1
- `versionDetail` (string, optional) — Detail description of this version
- `metadata` (string, optional) — Version metadata, UI stores meter position data into this field
- `tasks` (list of MeterTask, optional) — List of tasks for this version

### EventSchemaExportResult

Schema details of an event associated with a meter

- `name` (string, optional) — Event definition name
- `type` (integer, optional) — Schema type (1 = simple, 2 = advanced)
- `schema` (EventSchemaExportResultSchema, optional) — JSON schema

### ProxyBadRequestResponseErrorsItems

- `code` (string, optional) — Machine-readable error code identifying the failure type.
- `message` (string, optional) — Human-readable description of the error that provides more context about what went wrong.

### MediationErrorResponseData

Detailed response information for successful requests (e.g., instance info, job details).

- `id` (string, optional) — The instance ID.
- `sessionId` (string, optional) — The session ID of the meter instance.
- `jobId` (string, optional) — The job ID of the meter instance.
- `meterId` (integer, optional) — The ID of the meter.
- `version` (string, optional) — The meter version.
- `revision` (string, optional) — The meter revision.
- `runType` (integer, optional) — The run type of the instance.
- `runTypeDescription` (string, optional) — The description of the run type.
- `startTime` (string, optional) — The start time of the instance.
- `status` (integer, optional) — The job status of the instance.
- `statusDescription` (string, optional) — The status description of the instance.
- `canExportSummary` (boolean, optional) — Whether the instance can export summary information (internal usage).
- `hasLineageEnabled` (boolean, optional) — Whether lineage is enabled for the meter (internal usage).

### MediationErrorResponseError

Contains error details when the request fails.

- `code` (string, optional) — The error reason code (e.g., "70002006" for authorization errors).
- `message` (string, optional) — A human-readable description of the error.

### ErrorResponseReasonsItems

- `code` (string, optional) — The error code of response.
- `message` (string, optional) — The detail information of the error response

### UsageFieldMapping

- `name` (string, optional) — Field name
- `field` (string, optional) — Mapped field name
- `required` (boolean, optional) — Indicates if the field is required
- `dateFormat` (string, optional) — Date format if applicable

### MeterTask

- `id` (string, optional) — Operator ID
- `name` (string, optional) — Operator name
- `nodeType` (string, optional) — Operator node type (e.g., SOURCE, PROCESSOR, SINK)
- `operatorType` (string, optional) — Operator type (e.g., KAFKA, S3, LOCAL_FILE)
- `metadata` (map from string to any, optional) — Operator metadata
- `predecessors` (list of TransitionNode, optional) — Predecessor operators
- `extraConfig` (map from string to any, optional) — Extra configurations for the operator
- `setting` (map from string to any, optional) — Runtime settings for the operator

### EventSchemaExportResultSchema

JSON schema

- `description` (string, optional) — Schema description
- `type` (enum, optional) — Schema base type
  - Allowed values: `object`
- `title` (string, optional) — Schema title
- `required` (list of string, optional) — Required fields in the event
- `properties` (map from string to EventSchemaExportResultSchema, optional) — Field definitions in the schema

### TransitionNode

- `id` (string, optional) — Operator ID

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "name": "Customer Usage Meter",
  "description": "Meter tracking customer usage events for billing purposes",
  "type": "CUSTOM",
  "typeDefinition": {
    "sourceType": "ZUORA_BULK_API",
    "schemaId": "evt-def-12345",
    "fieldMappings": [
      {
        "name": "CustomerId",
        "field": "customer_id",
        "required": true,
        "dateFormat": ""
      },
      {
        "name": "UsageDate",
        "field": "usage_date",
        "required": true,
        "dateFormat": "yyyy-MM-dd"
      },
      {
        "name": "Quantity",
        "field": "quantity",
        "required": true,
        "dateFormat": ""
      }
    ],
    "configs": {
      "aggregation": "SUM",
      "timeZone": "UTC"
    }
  },
  "latestVersion": "1.2.0",
  "versions": [
    {
      "version": "1.0.0",
      "versionDetail": "Initial release of the meter",
      "metadata": "{\"uiPosition\":{\"x\":100,\"y\":200}}",
      "tasks": [
        {
          "id": "op-001",
          "name": "Source Kafka",
          "nodeType": "SOURCE",
          "operatorType": "KAFKA",
          "metadata": {
            "bootstrapServers": "kafka01.zuora.com:9092",
            "topic": "usage-events"
          },
          "predecessors": [],
          "extraConfig": {
            "retryCount": 3
          },
          "setting": {
            "batchSize": 500
          }
        },
        {
          "id": "op-002",
          "name": "Processor Filter",
          "nodeType": "PROCESSOR",
          "operatorType": "FILTER",
          "metadata": {
            "filterExpression": "eventType == 'usage'"
          },
          "predecessors": [
            {
              "id": "op-001"
            }
          ],
          "extraConfig": {},
          "setting": {
            "parallelism": 2
          }
        },
        {
          "id": "op-003",
          "name": "Sink S3",
          "nodeType": "SINK",
          "operatorType": "S3",
          "metadata": {
            "bucketName": "zuora-usage-data",
            "region": "us-east-1"
          },
          "predecessors": [
            {
              "id": "op-002"
            }
          ],
          "extraConfig": {},
          "setting": {
            "fileFormat": "parquet"
          }
        }
      ]
    }
  ],
  "schemas": [
    {
      "name": "usageEventSchema",
      "type": 1,
      "schema": {
        "description": "Schema for customer usage event",
        "type": "object",
        "title": "UsageEvent",
        "required": [
          "CustomerId",
          "UsageDate",
          "Quantity"
        ],
        "properties": {
          "CostCenter": {
            "description": "Cost center associated with usage",
            "type": "string"
          },
          "CustomerId": {
            "description": "Unique identifier for the customer",
            "type": "string"
          },
          "ProductCode": {
            "description": "Code of the product used",
            "type": "string"
          },
          "Quantity": {
            "description": "Quantity of usage",
            "type": "number"
          },
          "UsageDate": {
            "description": "Date of usage event",
            "type": "string"
          }
        }
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://rest.test.zuora.com/meters/export/meterId"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://rest.test.zuora.com/meters/export/meterId';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://rest.test.zuora.com/meters/export/meterId"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://rest.test.zuora.com/meters/export/meterId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://rest.test.zuora.com/meters/export/meterId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://rest.test.zuora.com/meters/export/meterId', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://rest.test.zuora.com/meters/export/meterId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://rest.test.zuora.com/meters/export/meterId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```