Revenue Recognition APIPublic preview
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.
Stripe 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_ to 1 May 2023 and parameters[interval_ to 1 Jun 2023.
Next, check whether the Report Run object succeeds by fetching the report run object:
The report run object ID starts with frr_.
When the object’s status is succeeded, you can download the CSV using its result. value, as in the following example:
The report run result ID starts with file_.
Report Run Parameters
| Report Type | Required Run Parameters | Optional Run Parameters |
|---|---|---|
| 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 |
|
|
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_
| Column Name | Default | Description |
|---|---|---|
| accounting_period | The accounting period | |
| open_accounting_period | The open accounting period; entries in open periods are subject to change | |
| currency | Three-letter ISO code for the currency of the amount. | |
| debit | The debited account | |
| credit | The credited account | |
| amount | Amount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN). | |
| credit_gl_code | The credited general ledger code | |
| debit_gl_code | The debited general ledger code |
By Price
API report type: revenue_
| Column Name | Default | Description |
|---|---|---|
| accounting_period | The accounting period | |
| open_accounting_period | The open accounting period; entries in open periods are subject to change | |
| currency | Three-letter ISO code for the currency of the amount. | |
| price_id | The price associated with this change. | |
| debit | The debited account | |
| credit | The credited account | |
| amount | Amount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN). | |
| credit_gl_code | The credited general ledger code | |
| debit_gl_code | The debited general ledger code |
By Product
API report type: revenue_
| Column Name | Default | Description |
|---|---|---|
| accounting_period | The accounting period | |
| open_accounting_period | The open accounting period; entries in open periods are subject to change | |
| currency | Three-letter ISO code for the currency of the amount. | |
| product_id | The product associated with this change. | |
| debit | The debited account | |
| credit | The credited account | |
| amount | Amount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN). | |
| credit_gl_code | The credited general ledger code | |
| debit_gl_code | The debited general ledger code |
By Customer
API report type: revenue_
| Column Name | Default | Description |
|---|---|---|
| accounting_period | The accounting period | |
| open_accounting_period | The open accounting period; entries in open periods are subject to change | |
| currency | Three-letter ISO code for the currency of the amount. | |
| customer_id | The customer associated with this change. | |
| debit | The debited account | |
| credit | The credited account | |
| amount | Amount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN). | |
| credit_gl_code | The credited general ledger code | |
| debit_gl_code | The debited general ledger code |
By Invoice
API report type: revenue_
| Column Name | Default | Description |
|---|---|---|
| accounting_period | The accounting period | |
| open_accounting_period | The open accounting period; entries in open periods are subject to change | |
| currency | Three-letter ISO code for the currency of the amount. | |
| transaction_model_id | The model in Stripe associated with this change - either an invoice line item, invoice, invoiceitem, charge, or etc. | |
| debit | The debited account | |
| credit | The credited account | |
| booked_date | The date that the ledger entry is added to the books. | |
| amount | Amount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN). | |
| debit_gl_code | The debited general ledger code | |
| credit_gl_code | The credited general ledger code | |
| invoice_id | The invoice associated with this change. Standalone charges or invoice items not associated with an invoice are null. | |
| invoice_line_item_id | The ID of the invoice line_item. | |
| invoice_item_id | The ID of the invoice item | |
| invoice_number | The customer unique number associated with the invoice. | |
| subscription_item_id | The ID of the subscription_item. | |
| price_id | The price associated with this change. Standalone charges or invoice items not associated with a price are null. | |
| product_id | The product associated with this price. | |
| customer_id | The customer associated with this change. | |
| subscription_id | The subscription associated with this change. | |
| charge_id | The charge associated with this change. | |
| refund_id | The refund associated with this change. | |
| dispute_id | The dispute associated with this change. | |
| presentment_currency | The presentment (customer facing) currency of the transaction. | |
| presentment_amount | The presentment (customer facing) amount. |
By Invoice Line Item
API report type: revenue_
| Column Name | Default | Description |
|---|---|---|
| accounting_period | The accounting period | |
| open_accounting_period | The open accounting period; entries in open periods are subject to change | |
| currency | Three-letter ISO code for the currency of the amount. | |
| transaction_model_id | The model in Stripe associated with this change—an invoice line item, invoice, invoice item, charge, and so on. | |
| debit | The debited account | |
| credit | The credited account | |
| booked_date | The date that the ledger entry is added to the books. | |
| amount | Amount change, expressed in major units of the currency (for example, dollars for USD, or pesos for MXN). | |
| debit_gl_code | The debited general ledger code | |
| credit_gl_code | The credited general ledger code | |
| invoice_id | The invoice associated with this change. Standalone charges or invoice items not associated with an invoice are null. | |
| invoice_line_item_id | The ID of the invoice line_item. | |
| invoice_item_id | The ID of the invoice item | |
| subscription_item_id | The ID of the subscription_item. | |
| price_id | The price associated with this change. Standalone charges or invoice items not associated with a price are null. | |
| product_id | The product associated with this price. | |
| customer_id | The customer associated with this change. | |
| subscription_id | The subscription associated with this change. | |
| charge_id | The charge associated with this change. | |
| refund_id | The refund associated with this change. | |
| dispute_id | The dispute associated with this change. | |
| presentment_currency | The presentment (customer facing) currency of the transaction. | |
| presentment_amount | The presentment (customer facing) amount. |
If you encounter any issues, you can contact revenue-recognition-api-beta@stripe.com.