HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
Product Docs

Explore - Invoices and workbook agent

Overview

Required plan

This feature may not be included in the Starter or Pro plans. If you are interested, please contact Recurly Sales to discuss upgrade options.

Prerequisites

  • Users must have Analytics user role permission.

Definition

The invoices Explore feature is a dynamic, versatile, and powerful tool that provides a custom view of your organization's data. It transforms raw data into insightful and actionable information, catering to a wide array of data needs. From invoice details to account information and various other fields, Explore allows you to delve deeply into your Recurly data.

Key benefits

  • Customizable reports for actionable insights: Recurly Explore provides flexible report-building capabilities, allowing you to create custom reports tailored to your specific business needs.
  • Comprehensive data views for deep analysis: From accounts to transactions, Explore offers predefined data views, enabling you to analyze every aspect of your Recurly data.
  • Optimized decision-making through detailed metrics: Use dimensions and measures to uncover patterns and make informed decisions that enhance business performance.
  • AI-assisted analytics: Use the Workbook Agent to ask data questions in plain language. The agent interprets your question, selects the relevant fields, and returns a result set or chart.

Key details

The invoices Explore includes all invoices and their corresponding line items. It does not contain transaction or gateway information. The data provided is particularly useful for building reports related to invoicing or accounting. Note that gateway, fraud, error code, or payment method information is not included in this Explore.

With the Recurly invoices Explore feature, you can easily create custom reports and visualize the data that matters most to your business.

Explore interface

The Explorer is divided into three areas:

Interface AreaDescription
Left panel -WorkbookAgent Ask natural-language questions about your invoice data. The agent suggests fields and runs queries on your behalf.
Center panel - Field pickerBrowse and search the full field catalog. Fields are grouped by topic. Click any field to add it to your active query. Use the In-use filter to see only selected fields.
Right panel - results areaToggle between Results (table view), Chart (visualization), or Both. Use the Options tab to configure axes, grouping, and chart type. Click Preview to run a sample query and verify your field selection before committing.

Using the Workbook Agent

The Workbook Agent is the fastest way to start an analysis. Type a question in the text box at the bottom of the left panel and press Enter (or click the send icon).

Example prompts:

  • "Show me total invoice revenue by plan for the last 30 days"
  • "Which accounts have open invoices older than 60 days?"
  • "Break down failed charges by dunning state this month"
  • "How many invoice line items are associated with add-ons?"

Switching between Agent and manual mode

You can use the Agent and the field picker together. After the agent populates a query, you can add or remove fields manually using the center panel. Changes are reflected immediately in the results view.

Opening an existing report

  1. Click the yellow Recurly logo in the Explore
  2. Either go to My documents or the Hub. My documents stores your private personal data reports and folders while the Hub is the shared workspace for the entire merchant site.
  3. Click on the folder or report to open
  4. Click on Edit or Explore in the upper right corner

Creating a new report

  1. Browse and search the full field catalog. Fields are grouped by data topic.
  2. Click any field to add it to your active query. Use the In-use filter to see only selected fields.
  3. Toggle between Results (table view), Chart (visualization), or both.
  4. Use the Options tab to configure axes, grouping, and chart type.

Available data

The field picker organizes all available dimensions and metrics by topic. Each topic maps to a set of underlying data entities:

DataDescription
Account Billing InfoPayment method details, billing address and card metadata associated with accounts
AccountsAccount-level attributes including account code, email, address, name, etc
Business EntitiesLegal entity data for multi-entity merchants, including entity name and tax region.
Dunning InfoRetry attempts, dunning state, and communication timing for failed payment recovery.
Invoice Line ItemsIndividual charges and credits at the line level, including unit amounts, quantities, and product codes.
InvoicesInvoice totals, state (open, collected, failed, voided), currency, and dates.
PlansPlan codes, names, intervals, and pricing tiers.
SubscriptionsSubscription state, start/end dates, trial info, and associated plan and add-on metadata.

Tips & best practices

  • Use Preview before adding many fields — it confirms the data shape without running a full query.
  • The In-use toggle in the field picker narrows the view to your current selection, making it easier to review what's included.
  • Save frequent queries as a Dashboard using the button in the top-right corner so teammates can access them without rebuilding.
  • For large date ranges, start with aggregated metrics (totals, counts) before drilling into line-level detail to keep load times fast.
  • The Workbook Agent works best with specific, scoped questions. Include a timeframe and at least one entity type (account, plan, subscription) for the most accurate results.

Saving a report

To save an explore:

  1. In the workbook, click File > Save.
  2. Give the document a Name and an optional Description
  3. Use the Locations browser to find and select the folder you want to save the document to. The document can be moved after saving if needed.
  4. Click Save to save the document.