Subscription add-ons
Explore the comprehensive details of your current subscription add-ons with the Subscription Add-ons export feature.
Overview
Required plan
This feature or setting is available to all customers on any Recurly subscription plan.
Definition
The Subscription Add-on export tool helps you to gather detailed information about all the subscription add-ons created within a specific timeframe. It is important to note that this export only includes details of the add-ons that are currently active and attached to subscriptions. Add-ons that have been removed will not feature in this export.
Filters
Time Range Filter
Utilize the Time Range Filter to view all active subscription add-ons that were activated within a chosen time frame. This feature relies on the "subscription activated_at" date mentioned in the export details.
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) |
|---|---|---|---|
| subscription_uuid | 5eg5bcc7ef8211e0a908005056b00005 | Unique identifier for a specific subscription plan. | string |
| add_on_add_on_code | extra | Code used to identify the add-on. | varchar(50) |
| subscription_add_on_quantity | 1 | Number of add-ons added to the subscription. | numeric |
| subscription_add_on_unit_amount_in_cents | 500 | Cost (in cents) of a unit of the add-on. | numeric |
| subscription_add_on_created_at | 2014-01-07 23:54:41 PST | The date and time the add-on was created, utilized for the date range filter. | timestamp |
| subscription_add_on_modified_at | 2014-01-07 23:54:41 PST | The date and time the add-on was last modified. | timestamp |
| subscription_add_on_deleted_at | 2014-01-07 23:54:41 PST | Deprecated column; it no longer populates due to filtering out add-ons with a deleted_at date. | timestamp |
| account_code | 239485723046981734 | Customer's account code to whom the subscription add-on belongs. | varchar(50) |
| add_on_name | Video Streaming | Name of the add-on that appears on the customer's invoice. | varchar(255) |
| add_on_type | fixed, usage | Indicates whether the add-on is fixed-price or usage-based. | string |
| subscription_currency | USD | Currency of the subscription and the unit amount in cents. | varchar(3) |
| subscription_add_on_percentage | 4.5 | If usage-based, indicates the percentage of the subscription add-on. | numeric |
| measured_unit_internal_name | Bandwidth Units | For usage-based add-ons, the internal name of the associated measured unit. | varchar(255) |
| measured_unit_display_name | GB | For usage-based add-ons, the display name of the associated measured unit. | varchar(50) |
| external_sku | abc123 | SKU of the sold item associated with this add-on, specified by the user. | varchar(50) |
| subscription_add_on_tier_type | flat, tiered, volume, stairstep | Pricing model used to calculate costs based on purchased quantity. | string |
| subscription_add_on_total_amount_in_cents | 1000 | Total amount for a subscription add-on, excluding usage add-ons. | numeric |
| subscription_add_on_source | source | Subscription add-on source. | string |
| subscription_add_on_unit_amount_in_decimal_cents | 1000 | Total amount for a subscription add-on, excluding usage add-ons. | numeric |
| subscription_add_on_billing_model | 1000 | Total amount for a subscription add-on, excluding usage add-ons. | string |
Version changelog
Version 5 - 3/9/2023
The addition of subscription_add_on_billing_model to indicate whether it’s term or period based billing.
Version 4 - 1/14/2021
The addition of subscription_add_on_unit_amount_in_decimal_cents to indicate add on unit amount in decimal cents.
Version 3 - 7/23/2020
The addition of column subscription_add_on_source to indicate add on source.
Version 2 - 4/2/2020
The addition of a column for External SKU for item add-ons Inclusion of columns for Add-On Tier Type and Add-On Total Amount
Updated 16 days ago