Products Catalog - export

Unlock detailed insights into your product catalog with the products catalog export.

Overview

Required plan

This feature or setting is available to all customers on any Recurly subscription plan.

Definition

The "Products Catalog" export provides comprehensive details of all product offerings, add-ons and items, whether active or inactive.

Filters

Versions Filter

  • The Versions filter allows you to select the version that is most appropriate for your needs. This is based on the version changelog at the bottom of this page.

Product Type Filter

The Product type filter allows you to select existing plan, add on, setup fee, or item

  • Plan: Recurring billing products that define the billing frequency and the product's base price, allowing businesses to create a revenue model that provides consistent income.
  • Add-on: Additional features, services, or products that customers can purchase alongside their subscription plan.
  • Setup fee: One time initial fee.
  • Item: Collection of the sellable units of a business. This can include standalone products, services, or even add-ons

Export On Filters

  • Created: Product created within the chosen timeframe.
  • Modified: Product altered in the specified period.

Time range filters

  • The Time range filter (dropdown) allows you to view data within a specific period such as last month, year to date or a custom date range. The Start Date and End Date will automatically update based on the value selected in the Time range filter. You can also choose "Between..." in the dropdown, which will allow you to enter a customized date range.

Exports table

Download Button Download our complete export schema

To help you identify and organize information effectively, the export provides a structured table that contains the following columns:

Note: The unique identifier for each record is the combination of product_id, plan_id, and add_on_id. If an item type is configured as an add-on, it can be associated with multiple plans; in such cases, the same product_id is reused across those plans.

Column NameExampleDescriptionData type (max size)
product_id:e28zov4fw0v2The api_id of the product (this matches item_api_id)string
plan_idp47mx1taq9b5The api_id of the planstring
add_on_idk91trm8xe2c7The api_id of the add_onstring
item_codeitem123The Item Code maps to the user-specified unique ID of the item that was sold on this adjustment.string
product_typeplan, add_on, setup_fee, itemThe type of product.string
product_codepink_sweaterThe unique Recurly identifier of the saved product used to create the product.string
external_skuPS1234The optional external SKU of the saved item used to create this add-on.string
product_namePink SweaterThe name of the saved product. This is also the name displayed on the invoice.string
product_descriptionSweater, color pinkThe description of the product.string
plan_codeGoldIf the product is associated with a plan or is a plan this is the code of the plan.string
plan_nameGold PlanIf the product is associated with a plan or is a plan this is the name of the plan.string
plan_interval_unitmonths, weeks, days, yearsThe interval type at which that plan is billed.string
plan_interval_length30The length of the interval type at which the plan is billed at.int64
plan_total_billing_cycles12The total number of bill cycles that the plan will bill for 1 term.int64
plan_trial_interval_unitmonths, weeks, days, yearsThe interval type that indicates the duration of the trial.string
plan_trial_interval_length12The length of the interval type that sets the duration of the trial.int64
trial_requires_billing_infofalseIndicates if the trial requires billing info.boolean
recurringtrue/falseIndicates if this charge will be recurring.boolean
optionaltrue/falseIndicates if this is required as part of a plan.boolean
tax_exempttrue/falseIndicates if the product is tax exempt.boolean
tax_codeP0000000, physicalTax code is a field associated with the product that we send to Avalara for tax calculations. If you are using Recurly's EU VAT feature, you can use values of 'unknown', 'physical', or 'digital'. If you have your own Avalara AvaTax account configured, you can use Avalara tax codes to assign custom tax rules.string
general_ledger_liability_codedefault_liabilityRevenue Recognition general ledger liability codestring
general_ledger_revenue_codedefault_revenueRevenue Recognition general ledger revenue codestring
performance_obligation_nameOver Time (Daily)Revenue Recognition performance obligation assigned to the product.string
accounting_codejr_accounting_codeOptional accounting_code assigned to the product.string
default_quantity1Default quantity assigned to the product (default is 1)int64
pricing_modelfixedThis is the method the product is billed. Values include fixed, usage, tiered, ramp, volume, stairstep, percentagestring
currencies[{"currency":"EUR","price_details":[{"unit_amount_in_cents":1000}]},{"currency":"USD","price_details":[{"unit_amount_in_cents":1000}]}]Json object of the currencies and associated pricesstring
custom_fields{"item": "so_custom_field"}Json object of any custom fields that are assigned to the productstring
stateactive, inactiveIf the product is available in Recurly the state will be “active”, if the product has been deleted and is no longer available in Recurly then the state will be “inactive”. It is possible for subscribers to have “inactive” products on their subscriptionstring
created_at2025-11-12 08:23:34 UTCTimestamp when the product was createdtimestamp
modified_at2025-11-12 08:23:34 UTCTimestamp when the product was last modifiedtimestamp
deleted_at2025-11-12 08:23:34 UTCTimestamp when the product was deletedtimestamp

Version changelog