Subscriptions Usage Records Export
This export will provide the individual usage records logged for your customer's usage-based subscription add-ons. This export is useful for your finance team trying to report on revenue earned before it is billed, as well as your product and marketing teams who may want to analyze customer usage.
For revenue recognition, be aware that the pricing information in this export is the customer's price and does not reflect any discounts factored in at the invoice level. Please review the Adjustments export for any discounts.
To access the Subscriptions Usage Records export, visit the Exports page under Reports in your Recurly site.
Plan Filter
All Plans
Export usage records for all plans with usage-based add-ons.
Monthly Usage Plan
Export usage records for a specific plan's usage-based add-ons.
Usage-Based Add-On Filter
All Usage-Based Add-Ons
If a specific plan is selected, exports usage records for all of the associated usage-based add-ons.
Specific Add-On
If a specific plan is selected, exports usage records for the specified usage-based add-on in that plan.
Date Range Filters
Created
Pull usage records created in Recurly during the selected time range.
Modified
Pull usage records updated in Recurly during the selected time range. This could be when the usage record was billed, or if you did an update through the API before it was billed.
Usage Timestamp
Pull usage records for the selected time range based on the usage record's usage_timestamp. Use this option if you want to know what was used in a period, regardless of whether or not it has been billed yet.
Recording Timestamp
Pull usage records recorded in your own system during the selected time range.
Billed
Pull usage records billed during the selected time range.
Export Contents
Column Name | Example | Description |
---|---|---|
usage_id | 400527199884543703 | The unique id of the usage record. |
account_code | 239485723046981734 | The account code of the customer whose usage record this is. |
subscription_id | 3598f5c395fc7e2f4a4eaa4888b9784b | The subscription id for the usage-based add-on this usage record is for. |
plan_code | mega_video | The plan code of the associated subscription. |
add_on_code | video_streaming | The add-on code of the usage record's subscription add-on. |
subscription_currency | USD | The currency of the subscription, which is also the currency of the unit_amount_in_cents for the add-on. |
usage_type | price, percentage | Whether the usage-based add-on has a pricing model of "price per unit" or "percentage of an amount". |
unit_amount_in_cents | 60 | If the usage-based add-on has a usage_type of "price", it will have a unit_amount_in_cents, which is the price per each usage amount. In the example, 60 is equivalent to $0.60 USD |
usage_percentage | 4.5 | If the usage-based add-on has a usage_type of "percentage", it will have a usage_percentage, which is the percentage of the monetary amount charged. |
measured_unit_internal_name | bandwith_streaming | The internal name of the associated measured unit. |
measured_unit_display_name | GB | The display name of the associated measured unit. This describes the amount column value. |
amount | 5 | The units used. If the usage_type is percentage, this amount is stored as the monetary amount in cents. For example, $5.00 USD would be stored as "500". |
merchant_tag | "Rate Lookup ID: 45768456845683435" | The merchant tag for the usage record, which is a custom field where you can store whatever you like. |
usage_timestamp | 2016-04-18 17:00:08 UTC | The usage timestamp, which is when the units were used. This maps to the line item date range on the invoice when the usage is billed and is important for revenue recognition. |
recording_timestamp | 2016-04-18 17:00:08 UTC | The recording timestamp, which is when the usage was recorded in your own system. This field will default to match the usage timestamp if a different timestamp is not specified. |
created_at | 2016-04-18 17:00:08 UTC | When the usage record was created in Recurly. |
modified_at | 2016-04-18 17:00:08 UTC | When the usage record was updated in Recurly. This could be when the usage record was billed or if an update was made before the usage record was billed. |
billed_at | 2016-04-18 17:00:08 UTC | When the usage record was billed on an invoice. |
Updated about 3 years ago