Products - export
Unlock detailed insights into your product catalog with the products export.
Overview
Required plan
This feature or setting is available to all customers on any Recurly subscription plan.
Definition
The "Products" 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.
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
To help you identify and organize information effectively, the export provides a structured table that contains the following columns:
| Column Name | Example | Description | Data type (max size) |
|---|---|---|---|
| item_id | l20fl6bek3mp | The system-generated unique identifier of the saved item utilized in creating this add-on. | string |
| item_name | Pink Sweater | The name of the saved item, mirrored in the add-on name on the customer's invoice. | varchar(255) |
| item_code | pink_sweater | The Recurly unique identifier for the saved item, also denoting the add-on code. | varchar(50) |
| external_sku | PS1234 | Optional external SKU of the saved item used in creating this add-on. | varchar(50) |
| item_status | enabled | The status of the item in your Recurly catalog, being either "enabled" or "disabled". | string |
| plan_code | platinum | The Recurly unique identifier for the plan affiliated with this subscription. | varchar(50) |
| plan_name | Platinum Plan | The contemporary name of the plan corresponding to this subscription. | varchar(255) |
| subscription_id | 3c42a34d1442f840 | Unique system-generated identifier for the subscription housing this item as an add-on. | varchar(32) |
| subscription_add_on_quantity | 1 | The count of add-ons integrated into the subscription for this item. | numeric |
| subscription_add_on_unit_amount_in_cents | 600 | The unit cost of the add-on in the subscription, denominated in cents; it may differ from the plan's or item's default pricing. | numeric |
| subscription_add_on_currency | USD | The currency utilized for billing in this subscription. | varchar(3) |
| subscription_add_on_created_at | 2020-02-07 10:18:34 MST | The date and time when the add-on was created, a critical filter for defining the date range. | timestamp |
| subscription_add_on_modified_at | 2020-02-07 10:18:34 MST | The latest modification date and time for the add-on. | timestamp |
| subscription_add_on_tier_type | flat | The subscription add-on tier type. | string |
| subscription_add_on_total_amount_in_cents | 12345 | Subscription add-on total amount in cents. | numeric |
| subscription_add_on_modified_at | source1 | Subscription add-on source. | string |
| subscription_add_on_tax_inclusive | false | Boolean flag to indicate whether the subscription add-on is tax inclusive. | boolean |
| item_api_id | e28zov4fw0v2 | Item API ID | string |
Version changelog
Updated about 6 hours ago