Zuora Product Documentation

https://docs.zuora.com/
Admin
Comprehensive documentation for Zuora's subscription billing, payment processing, revenue...
Tokens:1,365,433
Snippets:18,498
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Report Data Example Request

Source: https://docs.zuora.com/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/get-report-data

This snippet shows an example HTTPS GET request to retrieve report data. It includes parameters for pagination.

```HTTP
GET https://zconnectsandbox.zuora.com/rest/v1/reportruns/reportdata/ff8080815242b012015261b9f77009a0?offset=1&pageSize=100
```

--------------------------------

### Example Response Mappings Configuration

Source: https://docs.zuora.com/zuora-platform/system-management/settings-api/settings-api-tutorials/global-hub-tax-engine-settings

Demonstrates how to set up customized response mappings by providing key-value pairs.

```JSON
"responseMappings": {
   "taxRateDescription": "citation"
}
```

--------------------------------

### Get Report Run Response Example

Source: https://docs.zuora.com/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/get-report-run

This is an example of a successful JSON response from the Get Report Run API. It includes the report run ID, status, timestamps, and associated report details.

```JSON
{ "success": true, "response": { "reportType": "Detail", "id": "ff808081529f4e3401529fd61f080074", "reportId": "ff808081529f4e3401529fd373730070", "startedOn": 1453166692000, "status": "COMPLETED", "reportDefinition": "...", "updatedOn": 1453166695000 } }
```

--------------------------------

### Build New Quote Plans from Product Catalog

Source: https://docs.zuora.com/zuora-cpq/development-resources/zuora-cpq-component-library/zuora-cpq-global-classes/cpq-x-api/cpq-x-utilities/qplanbuilder-class

Demonstrates how to use the QPlanBuilder.makeFromCatalog method to create a list of QPlans for a quote based on provided Product Rate Plan IDs. It also includes assertions to verify the number of plans created and their type.

```Apex
public void test(){
 String quoteId = 'quoteId_xxx';
 List<Id> productRatePlanIds = new List<Id>{'rpId_xxx1', 'rpId_xxx2', 'rpId_xxx3'};
 List<zqu.QPlan> plans = zqu.QPlanBuilder.makeFromCatalog(quoteId, productRatePlanIds);
 System.assert(plans.size() == 3);
 for(zqu.QPlan plan : plans){
 // Check the type of Plan by looking at the Amendment
 System.assertEquals('NewProduct', plan.getAmendment().get('zqu__Type__c'));
 }
 }
```

--------------------------------

### Extract and Navigate to BigQuery Setup Example

Source: https://docs.zuora.com/zephr/configuration--integrations/settings/extensions/bigquery

Unzip the provided BigQuery setup archive and navigate into the extracted directory to begin the setup process.

```bash
$ unzip zephr-bigquery-setup-example.zip
$ cd zephr-bigquery-setup-example
```

--------------------------------

### Example Request Headers Configuration

Source: https://docs.zuora.com/zuora-platform/system-management/settings-api/settings-api-tutorials/global-hub-tax-engine-settings

Shows how to configure request headers as a key-value map, such as setting the Accept-encoding.

```JSON
"requestHeaders": {
   "Accept-encoding": "gzip, deflate, br"
}
```

--------------------------------

### Get Report Run Request Example

Source: https://docs.zuora.com/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/get-report-run

This example shows how to make a GET request to retrieve details of a specific report run using its ID. Replace 'ff808081529f4e3401529fd61f080074' with your actual report run ID.

```HTTP
GET https://zconnectsandbox.zuora.com/api/rest/v1/reportruns/ff808081529f4e3401529fd61f080074
```

--------------------------------

### Example Hosted Domain Configuration

Source: https://docs.zuora.com/zuora-cpq/zuora-cpq-configurations/deprecated-hosted-payment-pages-settings/hosted-payment-pages-in-older-zuora-quotes-version/create-hosted-payment-page-in-zuora

Specify the domain name where your callback file resides. This should be in the format `http://www.domain.com` or `https://www.domain.com`. For example, `https://c.na14.visual.force.com` or a Force.com Site like `https://hpm-developer-edition.na12.force.com`.

```text
https://c.na14.visual.force.com
```

```text
https://hpm-developer-edition.na12.force.com
```

--------------------------------

### Basic Authentication Example

Source: https://docs.zuora.com/zuora-platform/extensibility/workflow/create-and-manage-workflow-definitions/get-started-with-workflow/run-a-workflow-in-responsive-mode

Alternatively, use basic authentication with your username and password for API calls to the responsive endpoint.

```bash
Use the username and password shown in the Basic Auth section of the settings.
```

--------------------------------

### Get Report Data Request Examples

Source: https://docs.zuora.com/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/get-report-data

These examples show how to call the Get Report Data API for different Zuora environments. Remember to replace {ReportRunId} with your actual report run ID. The `offset` and `pageSize` parameters are used for pagination.

```HTTP
GET https://zconnectsandbox.zuora.com/api/rest/v1/reportruns/reportdata/{ReportRunId}?offset=1&pageSize=200
```

```HTTP
GET https://zconnect.zuora.com/api/rest/v1/reportruns/reportdata/{ReportRunId}?offset=1&pageSize=200
```

```HTTP
GET https://zconnect.sandbox.eu.zuora.com/api/rest/v1/reportruns/reportdata/{ReportRunId}?offset=1&pageSize=200
```

```HTTP
GET https://zconnect.eu.zuora.com/api/rest/v1/reportruns/reportdata/{ReportRunId}?offset=1&pageSize=200
```

```HTTP
GET https://zconnect.sandbox.na.zuora.com/api/rest/v1/reportruns/reportdata/{ReportRunId}?offset=1&pageSize=200
```

```HTTP
GET https://zconnect.na.zuora.com/api/rest/v1/reportruns/reportdata/{ReportRunId}?offset=1&pageSize=200
```

--------------------------------

### Example Header Configuration

Source: https://docs.zuora.com/zuora-platform/extensibility/mediation/meter-components/http-processor/configure-a-http-processor

Specify key-value pairs for headers to be sent with the API request.

```text
Content-Type: application/json
```

--------------------------------

### Starts With Comparison Operator

Source: https://docs.zuora.com/zuora-platform/extensibility/events-and-notifications/custom-events/custom-event-overview

Use the starts with operator (=^) to check if a string begins with a specific prefix. Example: Account.AccountNumber =^ 'E'.

```jexl
Account.AccountNumber =^ 'E'
```

--------------------------------

### Get Report Details by Label API Endpoint Examples

Source: https://docs.zuora.com/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/additional-operations/get-report-details-by-label

These are example endpoints for the Get Report Details by Label API, showing how to access report details based on a LabelId across different Zuora environments (API Sandbox and Production, US and EU Data Centers).

```HTTP
GET https://zconnectsandbox.zuora.com/api/rest/v1/reports/reportlabels/{LabelId}/report-details
```

```HTTP
GET https://zconnect.zuora.com/api/rest/v1/reports/reportlabels/{LabelId}/report-details
```

```HTTP
GET https://zconnect.sandbox.eu.zuora.com/api/rest/v1/reports/reportlabels/{LabelId}/report-details
```

```HTTP
GET https://zconnect.eu.zuora.com/api/rest/v1/reports/reportlabels/{LabelId}/report-details
```

```HTTP
GET https://zconnect.sandbox.na.zuora.com/api/rest/v1/reports/reportlabels/{LabelId}/report-details
```

```HTTP
GET https://zconnect.na.zuora.com/api/rest/v1/reports/reportlabels/{LabelId}/report-details
```

--------------------------------

### Example: Displaying User's First Name

Source: https://docs.zuora.com/zephr/configure-sites-pages-and-components-in-delivery/component-library/custom-components/add-user-variables-in-custom-component

This example demonstrates how to display a registered user's first name using the user variable format. It assumes 'Gwen' is the first name and the corresponding user attribute slug is used.

```text
For a registered user with a first name of Gwen, this would display as illustrated below:
```

--------------------------------

### Account Custom Field Mapping Example

Source: https://docs.zuora.com/zuora-platform/integration/integration-hub/advanced-connectors/billing-connector-for-salesforce-cpq/salesforce-cpq-connector-sync/custom-field-sync-and-mapping

Example of how to map custom fields for accounts between Salesforce CPQ and Zuora. This configuration is done during the Connector setup.

```text
accountCustomFields : source_apiName1, source_apiName2 zuoraAccountCustomFields: target_apiName1, target_apiName2
```

--------------------------------

### Initial CCV Calculation Example

Source: https://docs.zuora.com/zuora-revenue/advanced-revenue-operations/ccv-calculation-in-billing---revenue-integration

Demonstrates the initial CCV calculation for a subscription with a fixed quantity and price over a 12-month term.

```text
Charge| Segment| Version| CCV| Start Date| End Date  
---|---|---|---|---|---
C-0000001 | 1 | 1 | 10 * 12 * 5= 600.00 | 2020-01-01 | 2020-12-31  
```

--------------------------------

### NotificationController Apex Class Example

Source: https://docs.zuora.com/zuora-cpq/development-resources/zuora-cpq-component-library/zuora-cpq-global-components/notification-component-version-6.0

Example Apex controller demonstrating how to instantiate and pass NotificationOptions to the Notification component.

```Apex
public class NotificationController {
    public NotificationOptions notificationOptions;

    public NotificationController() {
        // Example: Display a success message
        notificationOptions = NotificationOptions.success('Operation Successful', 'Your changes have been saved.');

        // Example: Display a warning message with a button
        // notificationOptions = NotificationOptions.warning('Review Required', 'Some fields need your attention.');
        // notificationOptions.buttons = new List<NotificationOptions.ButtonOptions> { 
        //     new NotificationOptions.ButtonOptions('Review Now', 'reviewChanges') 
        // };
        // notificationOptions.modal = true;
    }

    // Example action for a button
    public PageReference reviewChanges() {
        // Handle the action
        return null;
    }
}
```

--------------------------------

### Get Report Data Example JSON Response

Source: https://docs.zuora.com/zuora-platform/data/zuora-reporting/reporting-api-reference/overview-of-the-zuora-reporting-api/get-report-data

This snippet displays an example JSON response when retrieving report data. It includes pagination details and a list of report records.

```JSON
{
  "success" : true,
  "response" : {
    "page" : [
      {
        "Invoice.CreatedDate" : "Dec 7, 2013 2:18:00 PM",
        "Account.Currency" : "USD",
        "Invoice.Amount" : "900.00",
        "BillToContact.AccountId" : "2c90838f42cf16030142cf215ecb0014"
      },
      {
        "Invoice.CreatedDate" : "Nov 7, 2013 11:20:00 AM",
        "Account.Currency" : "USD",
        "Invoice.Amount" : "400.00",
        "BillToContact.AccountId" : "402892f9423062950142308c64e503f3"
      },
      {
        "Invoice.CreatedDate" : "Jan 20, 2014 3:19:01 PM",
        "Account.Currency" : "EUR",
        "Invoice.Amount" : "984.00",
        "BillToContact.AccountId" : "8a858290439c517a0143b1edf32800ba"
      },
      {
        "Invoice.CreatedDate" : "Jan 20, 2014 3:24:00 PM",
        "Account.Currency" : "CAD",
        "Invoice.Amount" : "1,729.76",
        "BillToContact.AccountId" : "8a858290439c517a0143b1f4229c013f"
      }
    ],
    "size" : 100,
    "offset" : 1,
    "total" : 4
  }
}
```

--------------------------------

### Unsupported Alias Starting with a Number

Source: https://docs.zuora.com/zuora-platform/data/zuora-reporting/use-reporting/create-a-report-from-saved-data-queries

Aliases in saved data queries cannot begin with a number. This example illustrates an unsupported alias format.

```SQL
SELECT account.name AS "001AccountName", subscription.name AS "1234SubscriptionName" FROM account, subscription WHERE account.id = subscription.accountId
```
Tokens:
Raw