Skip to content
Create account
 or
Sign in
The Stripe Docs logo
/
Create account
Sign in

Revenue Recognition APIBeta

Access Stripe Revenue Recognition reports programmatically to automate your accrual accounting.

For accrual accounting, Stripe Revenue Recognition provides downloadable reports, such as a monthly summary and a revenue waterfall. You can download these reports in CSV format through the Dashboard or you can programmatically access them through the API.

Revenue Recognition has six supported report types:

  • revenue_recognition.debit_credit_summary.1
  • revenue_recognition.debit_credit_by_price.1
  • revenue_recognition.debit_credit_by_product.1
  • revenue_recognition.debit_credit_by_customer.1
  • revenue_recognition.debit_credit_by_invoice.1
  • revenue_recognition.debit_credit_by_invoice_line_item.1

Caution

Because this feature is in beta, the data fields might change.

Download a report

The following example downloads the debits and credits by summary for May 2021.

First, create a report run using Create a Report Run.

To get a report for May 2023, set parameters[interval_start] to 1 May 2023 and parameters[interval_end] to 1 Jun 2023.

Command Line
curl https://api.stripe.com/v1/reporting/report_runs \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -d report_type="revenue_recognition.debit_credit_summary.1" \
  -d "parameters[interval_start]"=1682899200 \
  -d "parameters[interval_end]"=1685577600

Next, check whether the Report Run object succeeds by fetching the report run object:

The report run object ID starts with frr_.

Command Line
curl https://api.stripe.com/v1/reporting/report_runs/{{REPORT_RUN_OBJECT_ID}} \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:"

When the object’s status is succeeded, you can download the CSV using its result.id value, as in the following example:

The report run result ID starts with file_.

Command Line
curl https://files.stripe.com/v1/files/{{REPORT_RUN_RESULT_ID}}/contents \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:

Report Run Parameters

Report TypeRequired Run ParametersOptional Run Parameters
revenue_recognition.debit_credit_summary.1
  • interval_start
  • interval_end
  • decimal_format
revenue_recognition.debit_credit_by_price.1
  • interval_start
  • interval_end
  • customer
  • decimal_format
revenue_recognition.debit_credit_by_product.1
  • interval_start
  • interval_end
  • customer
  • decimal_format
revenue_recognition.debit_credit_by_customer.1
  • interval_start
  • interval_end
  • decimal_format
revenue_recognition.debit_credit_by_invoice.1
  • interval_start
  • interval_end
  • customer
  • invoice
  • invoice_line_item
  • decimal_format
revenue_recognition.debit_credit_by_invoice_line_item.1
  • interval_start
  • interval_end
  • customer
  • invoice
  • invoice_line_item
  • decimal_format

Report Run Columns

By default, reports are run with the default set of columns. You can customize the selection and ordering of columns in the output by including the optional columns parameter with a list of column names. You can find the supported columns for each report type below.

Summary

API report type: revenue_recognition.debit_credit_summary.1

Column NameDefaultDescription
accounting_periodThe accounting period
open_accounting_periodThe open accounting period; entries in open periods are subject to change
currencyThree-letter ISO code for the currency of the amount.
debitThe debited account
creditThe credited account
amountAmount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN).
credit_gl_codeThe credited general ledger code
debit_gl_codeThe debited general ledger code

By Price

API report type: revenue_recognition.debit_credit_by_price.1

Column NameDefaultDescription
accounting_periodThe accounting period
open_accounting_periodThe open accounting period; entries in open periods are subject to change
currencyThree-letter ISO code for the currency of the amount.
price_idThe price associated with this change.
debitThe debited account
creditThe credited account
amountAmount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN).
credit_gl_codeThe credited general ledger code
debit_gl_codeThe debited general ledger code

By Product

API report type: revenue_recognition.debit_credit_by_product.1

Column NameDefaultDescription
accounting_periodThe accounting period
open_accounting_periodThe open accounting period; entries in open periods are subject to change
currencyThree-letter ISO code for the currency of the amount.
product_idThe product associated with this change.
debitThe debited account
creditThe credited account
amountAmount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN).
credit_gl_codeThe credited general ledger code
debit_gl_codeThe debited general ledger code

By Customer

API report type: revenue_recognition.debit_credit_by_customer.1

Column NameDefaultDescription
accounting_periodThe accounting period
open_accounting_periodThe open accounting period; entries in open periods are subject to change
currencyThree-letter ISO code for the currency of the amount.
customer_idThe customer associated with this change.
debitThe debited account
creditThe credited account
amountAmount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN).
credit_gl_codeThe credited general ledger code
debit_gl_codeThe debited general ledger code

By Invoice

API report type: revenue_recognition.debit_credit_by_invoice.1

Column NameDefaultDescription
accounting_periodThe accounting period
open_accounting_periodThe open accounting period; entries in open periods are subject to change
currencyThree-letter ISO code for the currency of the amount.
transaction_model_idThe model in Stripe associated with this change - either an invoice line item, invoice, invoiceitem, charge, or etc.
debitThe debited account
creditThe credited account
booked_dateThe date that the ledger entry is added to the books.
amountAmount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN).
debit_gl_codeThe debited general ledger code
credit_gl_codeThe credited general ledger code
invoice_idThe invoice associated with this change. Standalone charges or invoice items not associated with an invoice are null.
invoice_line_item_idThe ID of the invoice line_item.
invoice_item_idThe ID of the invoice item
subscription_item_idThe ID of the subscription_item.
price_idThe price associated with this change. Standalone charges or invoice items not associated with a price are null.
product_idThe product associated with this price.
customer_idThe customer associated with this change.
subscription_idThe subscription associated with this change.
charge_idThe charge associated with this change.
refund_idThe refund associated with this change.
dispute_idThe dispute associated with this change.
presentment_currencyThe presentment (customer facing) currency of the transaction.
presentment_amountThe presentment (customer facing) amount.

By Invoice Line Item

API report type: revenue_recognition.debit_credit_by_invoice_line_item.1

Column NameDefaultDescription
accounting_periodThe accounting period
open_accounting_periodThe open accounting period; entries in open periods are subject to change
currencyThree-letter ISO code for the currency of the amount.
transaction_model_idThe model in Stripe associated with this change—an invoice line item, invoice, invoice item, charge, and so on.
debitThe debited account
creditThe credited account
booked_dateThe date that the ledger entry is added to the books.
amountAmount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN).
debit_gl_codeThe debited general ledger code
credit_gl_codeThe credited general ledger code
invoice_idThe invoice associated with this change. Standalone charges or invoice items not associated with an invoice are null.
invoice_line_item_idThe ID of the invoice line_item.
invoice_item_idThe ID of the invoice item
subscription_item_idThe ID of the subscription_item.
price_idThe price associated with this change. Standalone charges or invoice items not associated with a price are null.
product_idThe product associated with this price.
customer_idThe customer associated with this change.
subscription_idThe subscription associated with this change.
charge_idThe charge associated with this change.
refund_idThe refund associated with this change.
dispute_idThe dispute associated with this change.
presentment_currencyThe presentment (customer facing) currency of the transaction.
presentment_amountThe presentment (customer facing) amount.

If you encounter any issues, you can contact revenue-recognition-api-beta@stripe.com.

Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access program.
Check out our product changelog.
Questions? Contact Sales.
Powered by Markdoc
On this page
Download a report
Report Run Parameters
Report Run Columns
Summary
By Price
By Product
By Customer
By Invoice
By Invoice Line Item
Products Used
Revenue Recognition