HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
Product Docs

Explore - Invoices and workbook agent

Learn how to use Recurly's invoices Explore feature to build custom reports and analyze invoice and account data, including with the AI-powered Workbook Agent.

Invoices Explore gives you a flexible way to dig into your invoice and account data without waiting on a custom report from support. Build the exact view you need using the field picker, or ask the Workbook Agent a question in plain language and let it build the query for you.
Not included in Starter or Pro — contact Recurly Sales to upgrade

Prerequisites

  • Users must have the Analytics user role permission.

Definition

Invoices Explore is a dynamic, versatile tool that provides a custom view of your organization's invoice data. It transforms raw data — invoice details, account information, and more — into actionable information you can use to build reports for invoicing or accounting.

Key benefits

Customizable reports for actionable insights Flexible report-building capabilities let you create custom reports tailored to your specific business needs.
Comprehensive data views for deep analysis Predefined data views cover everything from accounts to transactions, so you can 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 improve business performance.
AI-assisted analytics Use the Workbook Agent to ask data questions in plain language. It interprets your question, selects the relevant fields, and returns a result set or chart.

Key details

Invoices Explore includes all invoices and their corresponding line items. It doesn't contain transaction or gateway information, which makes it particularly useful for reports related to invoicing or accounting.

NoteGateway, fraud, error code, and payment method information aren't included in this Explore.

Explore interface

The Explorer is divided into three areas:

Interface areaDescription
Left panel — Workbook AgentAsk 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 select 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, add or remove fields manually using the center panel — changes appear immediately in the results view.

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, and more.
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 and 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.
  • Use the In-use toggle in the field picker to narrow 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.

Creating a new report

1

Browse the field catalog

Browse and search the full field catalog. Fields are grouped by data topic.

2

Add fields to your query

Click any field to add it to your active query. Use the In-use filter to see only selected fields.

3

Choose your view

Toggle between Results (table view), Chart (visualization), or Both.

4

Configure the chart

Use the Options tab to configure axes, grouping, and chart type.

Saving a report

1

Open the Save dialog

In the workbook, select File > Save.

2

Name your document

Give the document a name and an optional description.

3

Choose a location

Use the Locations browser to find and select the folder you want to save the document to. You can move it after saving if needed.

4

Save the document

Select Save to save the document.

Opening an existing report

1

Open the Explore menu

Select the yellow Recurly logo in the upper-left corner of the Explore.

2

Choose a location

Go to My documents for your private reports and folders, or the Hub for the shared workspace used by the entire site.

3

Select a report

Select the folder or report you want to open.

4

Enter edit mode

Select File > Edit, or select the Edit button in the upper-right corner.

5

Save your changes

Save your updates by selecting File > Save.

Running or refreshing a report

Once you're in an existing report, you can run or refresh it with or without cache from the View menu.

  • Refresh — Re-runs the report against previously saved data. If you (or a colleague) ran the exact same query with the same filters, sorts, and fields within the last hour, Explore instantly loads those pre-saved results. It only sends a new query to your data source if the cache has expired, or if filters, sorts, or fields change in the report.
  • Refresh w/o cache — Bypasses the stored query results for the report and sends a direct query to your data source to pull live, up-to-the-minute data.

Did this page help you?