> ## 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.

# Renewal Performance Report

This report shows the renewal rate of subscriptions by Billing Plan, and Primary Product for a given period. The report includes details for the number of Expected Renewals, Successful Renewals, Scheduled or Pending Retries and the Renewal Rate per Period for Billing Plan and the primary Product. This report can be run for a past, present, or future period.

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. 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 **renewal\_performance\_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 | Reseller (Service Provider) Plan Identifier for the qualifying Billing Plan—must have one or more subscriptions within the calendar month or months of the Period. |
| Primary Product | Primary Product (SKU) associated with the subscription. |
| Period | Calendar month or group of months for which data is shown. |
| Expected Renewals | The number of expected renewals for a given Billing Plan- Primary Product pair for a given period. |
| Successful Renewal | The number of expected renewals that were successfully billed. |
| Scheduled or Pending Retry | The number of expected Renewals that are scheduled to be billed or are in Retry. |
| Renewal Rate | The number of Successful Renewals divided by the number of Expected Renewals. |
| Affiliate ID | The affiliate defined on the subscription. |
| Sub Affiliate ID | The sub-affiliate as defined on the subscription. |

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


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