Items — associated plans - export
Explore the Items - Associated Plans export to manage and track your catalog efficiently.
Overview
Required plan
This feature or setting is available to all customers on any Recurly subscription plan.
Definition
The "Items - Associated Plans" export function in Recurly permits users to generate a report containing detailed information on all plan add-ons created from a saved item in your catalog during a specified period. It focuses exclusively on add-ons that are presently linked to active plans, ensuring that your report only contains the most pertinent and up-to-date data.
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.
Item Name Filter
The Item name filter allows you to select existing item by name, code or SKU
Time Range Filter
This export can be filtered based on a specified time range using the "plan_add_on_created_at" date in the export.
- 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 internal identifier of the saved item used to create this add-on. | string |
| item_name | Pink Sweater | The name of the saved item used to create this add-on. This is also the add-on name on the invoice. | varchar(255) |
| item_code | pink_sweater | The unique Recurly identifier of the saved item used to create this add-on. This is also the add-on code. | varchar(50) |
| external_sku | PS1234 | The optional external SKU of the saved item used to create this add-on. | varchar(50) |
| item_status | enabled | The status of the item in your Recurly catalog, which can be "enabled" or "disabled". | string |
| plan_code | platinum | The unique Recurly identifier of the plan that offers this item as an add-on. | varchar(50) |
| plan_name | Platinum Plan | The current name of the plan that offers this item as an add-on. | varchar(255) |
| plan_add_on_unit_amount_in_cents | 1599 | The cost (in cents) of a unit of the add-on. | numeric |
| plan_add_on_currency | USD | The currency of the plan, which is the currency of the plan_add_on_unit_amount_in_cents. | varchar(3) |
| plan_add_on_created_at | 2020-02-05 15:52:46 MST | The date and time the add-on was created, used for date range filtering. | timestamp |
| plan_add_on_modified_at | 2020-02-05 15:52:46 MST | The date and time the add-on was last modified. | timestamp |
| plan_add_on_tier_type | flat | Add on Tier Type. | string |
| plan_allow_any_item_on_subscriptions | false | Whether the plan allows any item on subscriptions | boolean |
| item_api_id | e28zov4fw0v2 | Item API ID | string |
Version changelog
Version 6 - 2/5/2025
Addition of item_api_id.
Version 5 - 5/31/2022
Removal of plan_add_on_tax_inclusive column.
Version 4 - 1/13/2022
Addition of plan_add_on_tax_inclusive column.
Version 3 - 7/23/2020
Addition of plan_allow_any_item_on_subscriptions column.
Version 2 - 4/29/2020
Addition of plan_add_on_tier_type column.
Updated about 21 hours ago