> ## Documentation Index
> Fetch the complete documentation index at: https://docs.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Churn Report

This report shows details such as subscribers active at the beginning of a period, subscribers active at the end of a period, and active and passive churn for a given weekly or monthly period for all active billing plans. For every Billing Plan and Primary Product combination with at least one active subscription within the reporting period, the report provides a snapshot of how many subscribers were active at the start of the period, how many were active at the end of the period, and a break-down of the churn sources. This report presents progress for calendar months under way while also presenting net churn or growth for completed months.

This report is generated using the Reports 1.0 data engine.

| **Reports 1.0** data engine | Provides the data you need in the reports up to near real-time. Reports data is displayed in UTC time zone. Reports 1.0 lets you select which display columns to include in the report. Report generation typically lasts several hours. |
| - | - |

## To generate a one time report:

1. Enter the date range
2. Optional. Enter an Email address where you'd like to receive notifications when the report is available. A single email address can be entered.
3. Select the Affiliate ID as relevant for the report. Select **No Affiliate** if not required.
4. Click **Submit**.

   View the report in the **My Reports** page.

## To schedule a recurring report:

1. Toggle **Recurring** toggle to **Yes**.

2. Select a date for the first reporting period.

   **Note:** Reports display data occurring starting from the defined date. For example, a monthly report starting on March 1st displays data for the month of March up to March 31st.

3. Select the report's **Frequency**. Choose between Weekly, Monthly or Quarterly.

4. Optional. Enter an Email address where you'd like to receive notifications when the report is available. A single email address can be entered.

5. Optional. If you want to receive the report uploaded to an **SFTP Server**, enable this option and provide the required details.

   When enabled, a scheduled report will be uploaded to the specified SFTP Server. The SFTP report follows the **\<report name>-\<frequency>-\<timestamp>.csv** naming convention where:

   * **\<report name>** is the name of the report
   * **\<frequency>** is the defined frequency such as monthly, weekly, quarterly, daily or once
   * **\<timestamp>** is the format **YYYY-MM-DD"T"HH\_MI\_SS.TZ**, where TZ is the timezone offset, for example, 2022-01-27T10\_57\_02.433174455Z.
     For this report, the **\<report name>** is **churn\_report**.

   **Note:** An email notification is sent if there is an issue in generating or downloading the report on the specified SFTP Server.

6. Click **Submit**.

   The report is submitted and will be generated according to the details provided. If you have provided an email or SFTP details, you will be notified when it is available for viewing.

7. View the report in the **My Reports** page.

## Display Columns

**Note:** The report's display columns **order** is machine-generated and may therefore change without prior notice.

| Field | Description |
| - | - |
| Billing Plan | Billing Plan associated with the subscription. |
| Primary Product Description | The description of the primary Product associated with the subscription. |
| Primary Product ID | The identifier of the primary product associated with the subscription. |
| Period | The applicable date range. |
| Starting Subscribers | Number of Subscribers at the beginning of the period for the Billing Plan and Primary Product combination. |
| Ending Subscribers | Number of Subscribers at the end of the period of the Billing Plan and Primary Product combination. |
| Active Churn | Number of subscriptions canceled by customers. |
| Passive Churn | Number of subscriptions canceled due to inability to charge. |
| Expire Count | Number of subscriptions that have expired. |
| Affiliate ID | Affiliate associated with the Subscription. |
| Sub Affiliate ID | Sub-Affiliate associated with the Subscription. |

**Parent topic:**[Performance Reports](reportsPerformanceReportsAbout)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.