{"section":"tutorials","requestedLocale":"en","requestedSlug":"understanding-the-subscription-report","locale":"en","slug":"understanding-the-subscription-report","path":"docs/en/tutorials/subscriptions/understanding-the-subscription-report.md","branch":"main","content":"The subscription report is a document in `CSV` format that contains information about subscriptions, such as their creation date, customer email, and active SKU.\n\nYou can generate the report using the [Generate report](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3?endpoint=post-/api/rns/pvt/reports/-reportName-/documents) endpoint.\n\nThe following types of reports are available:\n\n- [Subscriptions with status](#subscriptions-with-status)\n- [Subscriptions scheduled between dates](#subscriptions-scheduled-between-dates)\n- [Subscriptions updated between dates](#subscriptions-updated-between-dates)\n- [Subscriptions created between dates](#subscriptions-created-between-dates)\n- [Subscriptions triggered between dates](#subscriptions-triggered-between-dates)\n\n> ℹ️ You can also use the endpoint [List report templates](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/reports) to learn the types of reports you can generate.\n\nIn this article, you’ll learn more about the data returned by each type of subscription report.\n\n## Subscriptions with status\n\nThe `subscriptionsWithStatus` report returns subscription data based on the status of the cycle run.\n\nThe columns correspond to specific information about the subscription, as described below:\n\n| **Field name** | **Description** |\n| :---: | :--- |\n| ID | Subscription ID. |\n| Customer Email | Email address of the customer. |\n| Customer Id | The ID of the customer. |\n| Status | Status of the subscription when the report was created. <br /> `TRIGGERED`: A subscription cycle run was triggered. <br /> `IN_PROCESS`: The subscription is being processed by the system (temporary status). <br /> `FAILURE`: An internal error occurred while running the subscription. <br /> `SUCCESS`: The subscription cycle was processed successfully. <br /> `EXPIRED`: The subscription wasn't renewed and exceeded the current deadline. <br /> `ORDER_ERROR`: The subscription cycle failed due to a _place order_ error. <br /> `PAYMENT_ERROR`: The subscription cycle failed due to a payment error. <br /> `SKIPED` (written this way): The subscription cycle was skipped; the subscription will run in the next cycle. <br /> `SUCCESS_WITH_NO_ORDER`: A subscription cycle was successfully processed, but the associated order has no items. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: A subscription cycle was successfully processed and has a partial order associated. <br /> `RE_TRIGGERED`: A manual re-run of the subscription cycle was triggered. <br /> `SCHEDULE_UPDATED`: The next subscription cycle date was updated. |\n| Has Active Items | Indicates whether the subscription has active items. <br /> `TRUE`: Has active items. <br /> `FALSE`: No active items. |\n| Is Skipped | Indicates the subscription cycle will be skipped. <br /> `TRUE`: The cycle will be skipped. <br /> `FALSE`: The cycle won't be skipped. |\n| Next Purchase Date | Date of the next scheduled purchase. |\n| Last Purchase Date | Date of the last purchase. |\n| Periodicity | Frequency of the subscription. |\n| Interval | Subscription interval. |\n| Purchase Day | Day of the subscription purchase. |\n| AddressId | ID of customer address. |\n| AddressType | Type of address. |\n| PaymentSystem Name | Payment method used in the subscription. |\n| Account Id | ID of the account. |\n| Selected Sla | The [Service Level Agreement (SLA)](https://vtex.com/en-us/trust/agreements) selected. |\n| Cycle | Number that identifies the cycle of the subscription. |\n| Created At | Date the subscription was created. |\n| Last Update | Date of the last update. |\n| Subscriptions Items Count | Number of items in the subscription. |\n| Subscriptions Item Id | ID of the subscription item. |\n| Subscriptions Item Status | Status of the subscription item. |\n| Subscriptions Item Sku Id | SKU of the subscription item. |\n| Subscriptions Item PriceAtSubscriptionDate | Item price at subscription time. |\n| Subscriptions Item Quantity | Number of items in the subscription. |\n| Subscriptions Item Is Skipped | Indicates if the item will be skipped. <br /> `TRUE`: The item will be skipped. <br /> `FALSE`: The item won't be skipped. |\n| Subscriptions Item Cycle | Cycle of the subscription item. |\n| Subscriptions Item OriginalOrder | Original order of the subscription item. |\n\n## Subscriptions scheduled between dates\n\nThe `subscriptionsScheduledBetweenDate` report returns data on subscriptions scheduled within a date range.\n\nThe columns correspond to specific information about the subscription, as described below:\n\n| **Field name** | **Description** |\n| :---: | :--- |\n| ID | Subscription ID. |\n| Customer Email | Email address of the customer. |\n| Customer Id | The ID of the customer. |\n| Status | Status of the subscription when the report was created. <br /> `TRIGGERED`: A subscription cycle run was triggered. <br /> `IN_PROCESS`: The subscription is being processed by the system (temporary status). <br /> `FAILURE`: An internal error occurred while running the subscription. <br /> `SUCCESS`: The subscription cycle was processed successfully. <br /> `EXPIRED`: The subscription wasn't renewed and exceeded the current deadline. <br /> `ORDER_ERROR`: The subscription cycle failed due to a _place order_ error. <br /> `PAYMENT_ERROR`: The subscription cycle failed due to a payment error. <br /> `SKIPED` (written this way): The subscription cycle was skipped; the subscription will run in the next cycle. <br /> `SUCCESS_WITH_NO_ORDER`: A subscription cycle was successfully processed, but the associated order has no items. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: A subscription cycle was successfully processed and has a partial order associated. <br /> `RE_TRIGGERED`: A manual re-run of the subscription cycle was triggered. <br /> `SCHEDULE_UPDATED`: The next subscription cycle date was updated. |\n| Has Active Items | Indicates whether the subscription has active items. <br /> `TRUE`: Has active items. <br /> `FALSE`: No active items. |\n| Is Skipped | Indicates the subscription cycle will be skipped. <br /> `TRUE`: The cycle will be skipped. <br /> `FALSE`: The cycle won't be skipped. |\n| Next Purchase Date | Date of the next scheduled purchase. |\n| Last Purchase Date | Date of the last purchase. |\n| Periodicity | Frequency of the subscription. |\n| Interval | Interval between orders. |\n| Purchase Day | Day of the subscription purchase. |\n| AddressId | ID of the customer address. |\n| AddressType | Type of address. |\n| PaymentSystem Name | Payment method used in the subscription. |\n| Account Id | ID of the account. |\n| Selected Sla | The [Service Level Agreement (SLA)](https://vtex.com/en-us/trust/agreements) selected. |\n| Cycle | Number that identifies the cycle of the subscription. |\n| Created At | Date the subscription was created. |\n| Last Update | Date of the last update. |\n| Subscriptions Items Count | Number of items in the subscription. |\n| Subscriptions Item Id | ID of the subscription item. |\n| Subscriptions Item Status | Status of the subscription item. |\n| Subscriptions Item Sku Id | SKU of the subscription item. |\n| Subscriptions Item PriceAtSubscriptionDate | Item price at subscription time. |\n| Subscriptions Item Quantity | Number of items in the subscription. |\n| Subscriptions Item Is Skipped | Indicates if the item will be skipped. <br /> `TRUE`: The item will be skipped. <br /> `FALSE`: The item won't be skipped. |\n| Subscriptions Item Cycle | Cycle of the subscription item. |\n| Subscriptions Item OriginalOrder | Original order of the subscription item. |\n\n## Subscriptions updated between dates\n\nThe `subscriptionsUpdatedBetweenDate` report returns data on subscriptions updated within a date range.\n\nThe columns correspond to specific information about the subscription, as described below:\n\n| **Field name** | **Description** |\n| :---: | :--- |\n| ID | Subscription ID. |\n| Customer Email | Email address of the customer. |\n| Customer Id | The ID of the customer. |\n| Status | Status of the subscription when the report was created. <br /> `TRIGGERED`: A subscription cycle run was triggered. <br /> `IN_PROCESS`: The subscription is being processed by the system (temporary status). <br /> `FAILURE`: An internal error occurred while running the subscription. <br /> `SUCCESS`: The subscription cycle was processed successfully. <br /> `EXPIRED`: The subscription wasn't renewed and exceeded the current deadline. <br /> `ORDER_ERROR`: The subscription cycle failed due to a _place order_ error. <br /> `PAYMENT_ERROR`: The subscription cycle failed due to a payment error. <br /> `SKIPED` (written this way): The subscription cycle was skipped; the subscription will run in the next cycle. <br /> `SUCCESS_WITH_NO_ORDER`: The subscription cycle was completed successfully, but no items were in the order. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: A subscription cycle was completed successfully with a partial order. <br /> `RE_TRIGGERED`: A manual re-run of the subscription cycle was triggered. <br /> `SCHEDULE_UPDATED`: The next subscription cycle date was updated. |\n| Has Active Items | Indicates whether the subscription has active items. <br /> `TRUE`: Has active items. <br /> `FALSE`: No active items. |\n| Is Skipped | Indicates the subscription cycle will be skipped. <br /> `TRUE`: The cycle will be skipped. <br /> `FALSE`: The cycle won't be skipped. |\n| Next Purchase Date | Date of the next scheduled purchase. |\n| Last Purchase Date | Date of the last purchase. |\n| Periodicity | Frequency of the subscription. |\n| Interval | Interval between orders. |\n| Purchase Day | Day of the subscription purchase. |\n| AddressId | ID of customer address. |\n| AddressType | Type of address. |\n| PaymentSystem Name | Payment method used in the subscription. |\n| Account Id | ID of the account. |\n| Selected Sla | The [Service Level Agreement (SLA)](https://vtex.com/en-us/trust/agreements) selected. |\n| Cycle | Number that identifies the cycle of the subscription. |\n| Created At | Date the subscription was created. |\n| Last Update | Date of the last update. |\n| Subscriptions Items Count | Number of items in the subscription. |\n| Subscriptions Item Id | ID of the subscription item. |\n| Subscriptions Item Status | Status of the subscription item. |\n| Subscriptions Item Sku Id | SKU of the subscription item. |\n| Subscriptions Item PriceAtSubscriptionDate | Item price at subscription time. |\n| Subscriptions Item Quantity | Number of items in the subscription. |\n| Subscriptions Item Is Skipped | Indicates if the item will be skipped. <br /> `TRUE`: The item will be skipped. <br /> `FALSE`: The item won't be skipped. |\n| Subscriptions Item Cycle | Cycle of the subscription item. |\n| Subscriptions Item OriginalOrder | Original order of the subscription item. |\n\n## Subscriptions created between dates\n\nThe `subscriptionsCreatedBetweenDate` report returns data on subscriptions created within a date range.\n\nThe columns correspond to specific information about the subscription, as described below:\n\n| **Field name** | **Description** |\n| :---: | :--- |\n| ID | Subscription ID. |\n| Customer Email | Email address of the customer. |\n| Customer Id | The ID of the customer. |\n| Status | Status of the subscription when the report was created. <br /> `TRIGGERED`: A subscription cycle run was triggered. <br /> `IN_PROCESS`: The subscription is being processed by the system (temporary status). <br /> `FAILURE`: An internal error occurred while running the subscription. <br /> `SUCCESS`: The subscription cycle was processed successfully. <br /> `EXPIRED`: The subscription wasn't renewed and exceeded the current deadline. <br /> `ORDER_ERROR`: The subscription cycle failed due to a _place order_ error. <br /> `PAYMENT_ERROR`: The subscription cycle failed due to a payment error. <br /> `SKIPED` (written this way): The subscription cycle was skipped; the subscription will run in the next cycle. <br /> `SUCCESS_WITH_NO_ORDER`: A subscription cycle was successfully processed, but the associated order has no items. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: A subscription cycle was successfully processed and has a partial order associated. <br /> `RE_TRIGGERED`: A manual re-run of the subscription cycle was triggered. <br /> `SCHEDULE_UPDATED`: The next subscription cycle date was updated. |\n| Has Active Items | Indicates whether the subscription has active items. <br /> `TRUE`: Has active items. <br /> `FALSE`: No active items. |\n| Is Skipped | Indicates the subscription cycle will be skipped. <br /> `TRUE`: The cycle will be skipped. <br /> `FALSE`: The cycle won't be skipped. |\n| Next Purchase Date | Date of the next scheduled purchase. |\n| Last Purchase Date | Date of the last purchase. |\n| Periodicity | Frequency of the subscription. |\n| Interval | Interval between orders. |\n| Purchase Day | Day of the subscription purchase. |\n| AddressId | ID of customer address. |\n| AddressType | Type of address. |\n| PaymentSystem Name | Payment method used in the subscription. |\n| Account Id | ID of the account. |\n| Selected Sla | The [Service Level Agreement (SLA)](https://vtex.com/en-us/trust/agreements) selected. |\n| Cycle | Number that identifies the cycle of the subscription. |\n| Created At | Date the subscription was created. |\n| Last Update | Date of the last update. |\n| Subscriptions Items Count | Number of items in the subscription. |\n| Subscriptions Item Id | ID of the subscription item. |\n| Subscriptions Item Status | Status of the subscription item. |\n| Subscriptions Item Sku Id | SKU of the subscription item. |\n| Subscriptions Item PriceAtSubscriptionDate | Item price at subscription time. |\n| Subscriptions Item Quantity | Number of items in the subscription. |\n| Subscriptions Item Is Skipped | Indicates if the item will be skipped. <br /> `TRUE`: The item will be skipped. <br /> `FALSE`: The item won't be skipped. |\n| Subscriptions Item Cycle | Cycle of the subscription item. |\n| Subscriptions Item OriginalOrder | Original order of the subscription item. |\n\n## Subscriptions triggered between dates\n\nThe `executionsBetweenDate` report returns data on subscriptions executed within a date range.\n\nThe columns correspond to specific information about the subscription, as described below:\n\n| **Field name** | **Description** |\n| :---: | :--- |\n| Id | Subscription ID. |\n| OrderGroup | ID of the order generated by the report. |\n| E-mail | Email address of the customer. |\n| Customer Id | The ID of the customer. |\n| Skus | SKUs of the subscription products. |\n| Order | Number of the order. |\n| Value | Price of the subscription. |\n| cycleCount | Number that identifies the cycle of the subscription. |\n| date | Date the subscription was created. |\n| IsInRetry | Indicates whether a new retry can be attempted or if the subscription cycle has ended. <br /> `TRUE`: The subscription is still in the retry cycle and there are pending attempts. <br /> `FALSE`: The subscription cycle has ended. |\n| Status | Status of the subscription at the time the report was created. <br /> `TRIGGERED`: A subscription cycle run was triggered. <br /> `IN_PROCESS`: The subscription is being processed by the system (temporary status). <br /> `FAILURE`: An internal error occurred while running the subscription. <br /> `SUCCESS`: The subscription cycle was processed successfully. <br /> `EXPIRED`: The subscription wasn't renewed and exceeded the current deadline. <br /> `ORDER_ERROR`: The subscription cycle failed due to a _place order_ error. <br /> `PAYMENT_ERROR`: The subscription cycle failed due to a payment error. <br /> `SKIPED` (written this way): The subscription cycle was skipped; the subscription will run in the next cycle. <br /> `SUCCESS_WITH_NO_ORDER`: A subscription cycle was successfully processed, but the associated order has no items. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: A subscription cycle was successfully processed and has a partial order associated. <br /> `RE_TRIGGERED`: A manual re-run of the subscription cycle was triggered. <br /> `SCHEDULE_UPDATED`: The next subscription cycle date was updated. |\n| messageParsed | Message returned by Checkout during the subscription run. |\n| CreatedAt | Date the subscription was created. |\n| LastUpdate | Date of the last update. |\n| ActiveSkus | Active SKUs in the subscription. |"}