The Reference Docs Developer Hub

Welcome to the Reference Docs developer hub. You'll find comprehensive guides and documentation to help you start working with Reference Docs as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Revenue Recognition Schedules Export

For information about the Revenue Recognition feature that generates data in this export and how to configure this feature, visit Revenue Recognition

Revenue Recognition Schedules

The Revenue Recognition Schedules export provides a list of all schedules from each charge or credit and the corresponding revenue amortization information.

This export will only appear in the admin console for for sites that have enabled the feature.

Invoice Status Filter

All

Every invoice generated within your Recurly site, regardless of status.

Open

All invoices that have not received a payment attempt. This status has a value of 'pending' in the export and does not include invoice with a 'past_due' status. This status only exists for manual invoices. If you see this status for an automatically collected invoice, it may mean that the payment attempt had a transaction communication error. This filter will also include all credit invoices which have not been fully allocated to charge invoices.

Closed

All successfully collected invoices. This status has a value of 'paid' in the export and does not include the 'failed' status. It is important to note that the associated credit card, PayPal, or Amazon transaction with a paid invoice may not be settled with the gateway. Allow at least 1 to 3 business days for transaction settlement with the gateway. This will also include all credit invoices which have been fully allocated to charge invoices.

Past Due

All automatic invoices that attempted collection, but payment failed, or manual invoices that have reached their due date. Payment for automatic invoices will be retried automatically through the dunning process.

Failed

All invoices that have either experienced 20 declines, or have been through the dunning process without successful payment. These invoices will not be retried. It is important to note that failed invoices will clear the owed balance from the account and will not attempt any future collections, but the charge line items will still exist in the account history.

Time Range Filter

Created

The revenue recognition schedules export uses the invoice_created_at date column for the time range filter. In other words, all schedules from invoices created in the selected time range will be included in the results.

Export Contents

Column Name
Example
Description

revenue_schedule_id

224934254870915

the unique identifier of the revenue schedule

invoice_number

192880

The invoice number from the Recurly UI.

invoice_date

2017-06-01 00:00:00 UTC

Creation date of the invoice.

invoice_state

paid, processing, open, failed

the current state of the invoice

account_code

11734

Account code being charged for this invoice.

accounting_code

monthly_fee

Internal accounting code for a specific invoice line item. This value will only populate if you define an accounting code for the line item. Accounting codes can be defined for all line items. Plan set-up fees and plan free trial charges will inherit the plan's accounting code.

line_item_id

3a6ae2555a2e2a76c077604bf5b90457

Unique internal identifier for the adjustment. Also called line_item_uuid or adjustment_uuid in other exports.

line_item_start_date

2017-06-01 12:00:00 UTC

Bill cycle start date for a specific invoice line item. Equivalent to line_item_start_date in the deprecated Invoices export.

line_item_end_date

2017-07-01 12:00:00 UTC

Bill cycle end date for a specific invoice line item. This date will not exist for custom charges (one-time).

origin

plan, add_on, credit, charge

the original source for a line item. A credit created from an original charge will have the value of the charge's origin. (plan = subscription fee, plan_trial = trial period 0 amount charge, setup_fee = subscription setup fee, add_on = subscription add-on fee, debit = custom charge through the UI or Adjustments API, one_time = custom charge through the Transactions API, credit = custom credit

days

31

number of days between line_item_start_date and line_item_end_date

amount_per_day

4.88

the total amount divided by the number of days

total_amount

1000

total amount of the charge to be recognized for this schedule, in other words "subtotal after discounts)

currency

USD

currency of the line item

schedule_type

at_range_start, evenly

the way in which revenue is recognized for that schedule, as defined in the plan settings for revenue recognition

revenue_recognition_date

2017-06-05 00:00:00 UTC

the date revenue is recognized. only populated if schedule type is at_range_start or at_rate_end

deferred_revenue_balance

evenly

reflects the total remaining deferred revenue to be recognized as of the date the export is requested
For example, if you specify an export date range of Dec 1- 31, the deferred revenue balance will calculate all remaining revenue on the schedule yet to be recognized as of December 31st.

arrears

0

the portion of the line item that applies to the past, i.e. before time range "start date"

month_1

20

the total amount recognized in a specific month. Note that the first month will be the current month

month_2

20

the total amount recognized in a specific month. The second column will be the month after the current month

month_3, etc.

20

the total amount recognized in a specific month. There will be a column for each month after the current month, creating 12 columns of months in total

future_revenue

90

revenue to be recognized in the future past 12 months from the current month

invoice_origin

purchase, refund

The event that created the invoice. Invoices issued before the Credit Invoices feature was enabled on your site will have either purchase or refund as the value. Once Credit Invoices is enabled, you can see new origins like renewal, immediate_change, and write_off.

Revenue Recognition Schedules Export


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.