Items — associated subscriptions - export
Unlock detailed insights into your subscription add-ons with the Items - Associated Subscriptions export.
Overview
Required plan
This feature or setting is available to all customers on any Recurly subscription plan.
Definition
The "Items - Associated Subscriptions" export provides comprehensive details of all subscription add-ons generated from a saved item in your catalog over a certain period. It focuses on add-ons linked to renewing, future start, last billing period, and paused subscriptions, omitting details from canceled or expired subscriptions.
Filters
Date Range Filter
Customize your export to focus on renewing, future start, last billing period, and paused subscriptions formed during a selected period, leveraging the "subscription_add_on_created_at" date in the export to narrow down your data.
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
Version 5 - 2/5/2025
Addition of item_api_id.
Version 4 - 1/13/2022
Addition of subscription_add_on_tax_inclusive column.
Version 3 - 7/23/2020
Addition of subscription_add_on_source column.
Version 2 - 4/29/2020
Addition of subscription_add_on_tier_type, subscription_add_on_total_amount_in_cents columns.
Updated 3 months ago