{"section":"tutorials","requestedLocale":"pt","requestedSlug":"entendendo-o-relatorio-de-assinaturas","locale":"pt","slug":"entendendo-o-relatorio-de-assinaturas","path":"docs/pt/tutorials/assinaturas/entendendo-o-relatorio-de-assinaturas.md","branch":"main","content":"O relatório de assinaturas é um documento em formato `.csv` com informações sobre as assinaturas, como data da criação, email do cliente, SKUs ativos da assinatura, entre outros dados.\n\nVocê pode gerar o relatório utilizando o endpoint [Generate report](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3?endpoint=post-/api/rns/pvt/reports/-reportName-/documents).\n\nExistem os seguintes tipos de relatórios:\n\n- [Assinaturas com status](#assinaturas-com-status)\n- [Assinaturas programadas entre datas](#assinaturas-programadas-entre-datas)\n- [Assinaturas atualizadas entre datas](#assinaturas-atualizadas-entre-datas)\n- [Assinaturas criadas entre datas](#assinaturas-criadas-entre-datas)\n- [Assinaturas executadas entre datas](#assinaturas-executadas-entre-datas)\n\n> ℹ️ Você também pode usar o endpoint [List report templates](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3#get-/api/rns/pvt/reports) para descobrir quais tipos de relatório você consegue gerar.\n\nNeste artigo, você saberá mais detalhes sobre cada informação que os diferentes tipos de relatório de assinaturas retornam.\n\n## Assinaturas com status\n\nO relatório `subscriptionsWithStatus` retorna dados de assinaturas com base no status da execução do ciclo.\n\nAs colunas correspondem a uma informação específica sobre a assinatura, conforme descrito abaixo.\n\n| **Nome do campo** | **Descrição** |\n| :---: | :--- |\n| ID | ID da assinatura. |\n| Customer Email | Email do cliente. |\n| Customer Id | ID do cliente. |\n| Status | Status da assinatura no momento de gerar o relatório. <br /> `TRIGGERED`: Uma execução do ciclo de assinatura foi acionada. <br /> `IN_PROCESS`: A assinatura está sendo processada pelo sistema (status temporário). <br /> `FAILURE`: Ocorreu um erro interno na execução da assinatura. <br /> `SUCCESS`: O ciclo de assinatura foi processado com sucesso. <br /> `EXPIRED`: A assinatura não foi renovada e ultrapassou a data limite vigente. <br /> `ORDER_ERROR`: O ciclo de assinatura não foi executado devido a um erro no _place order_ do pedido. <br /> `PAYMENT_ERROR`: O ciclo de assinatura não foi executado devido a um erro no pagamento. <br /> `SKIPED` (escrito desta maneira): Uma execução de ciclo de assinatura foi ignorada e a assinatura será executada no próximo ciclo. <br /> `SUCCESS_WITH_NO_ORDER`: Um ciclo de assinatura foi executado com sucesso e o pedido atrelado não possui itens. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: Um ciclo de assinatura foi executado com sucesso e possui um pedido parcial atrelado. <br /> `RE_TRIGGERED`: Uma re-execução de ciclo da assinatura foi acionada manualmente. <br /> `SCHEDULE_UPDATED`: A data da próxima execução de ciclo da assinatura foi atualizada. |\n| Has Active Items | Informa se a assinatura tem itens ativos. <br /> `TRUE`: Tem itens ativos. <br /> `FALSE`: Não tem itens ativos. |\n| Is Skipped | Informa se o ciclo da assinatura será pulado. <br /> `TRUE`: O ciclo será pulado. <br /> `FALSE`: O ciclo não será pulado. |\n| Next Purchase Date | Data da próxima compra. |\n| Last Purchase Date | Data da última compra. |\n| Periodicity | Periodicidade da assinatura. |\n| Interval | Intervalo da assinatura. |\n| Purchase Day | Dia da compra da assinatura. |\n| AddressId | ID do endereço do cliente. |\n| AddressType | Tipo do endereço. |\n| PaymentSystem Name | Tipo de pagamento da assinatura. |\n| Account Id | ID da conta. |\n| Selected Sla | O [Service Level Agreement (SLA)](https://vtex.com/pt-br/trust/contratos) escolhido. |\n| Cycle | Número que identifica o ciclo da assinatura. |\n| Created At | Data de criação da assinatura. |\n| Last Update | Última atualização da assinatura. |\n| Subscriptions Items Count | Contagem de itens da assinatura. |\n| Subscriptions Item Id | ID dos itens da assinatura. |\n| Subscriptions Item Status | Status dos itens da assinatura. |\n| Subscriptions Item Sku Id | SKU dos itens da assinatura. |\n| Subscriptions Item PriceAtSubscriptionDate | Valor dos itens no momento da assinatura. |\n| Subscriptions Item Quantity | Quantidade de itens na assinatura. |\n| Subscriptions Item Is Skipped | Informa se os itens serão pulados. <br /> `TRUE`: Os itens serão pulados. <br /> `FALSE`: Os itens não serão pulados. |\n| Subscriptions Item Cycle | Ciclo dos itens da assinatura. |\n| Subscriptions Item OriginalOrder | Pedido original dos itens da assinatura. |\n\n## Assinaturas programadas entre datas\n\nO relatório `subscriptionsScheduledBetweenDate` retorna dados de assinaturas programadas entre um período de datas.\n\nAs colunas correspondem a uma informação específica sobre a assinatura, conforme descrito abaixo.\n\n| **Nome do campo** | **Descrição** |\n| :---: | :--- |\n| ID | ID da assinatura. |\n| Customer Email | Email do cliente. |\n| Customer Id | ID do cliente. |\n| Status | Status da assinatura no momento de gerar o relatório. <br /> `TRIGGERED`: Uma execução do ciclo de assinatura foi acionada. <br /> `IN_PROCESS`: A assinatura está sendo processada pelo sistema (status temporário). <br /> `FAILURE`: Ocorreu um erro interno na execução da assinatura. <br /> `SUCCESS`: O ciclo de assinatura foi processado com sucesso. <br /> `EXPIRED`: A assinatura não foi renovada e ultrapassou a data limite vigente. <br /> `ORDER_ERROR`: O ciclo de assinatura não foi executado devido a um erro no _place order_ do pedido. <br /> `PAYMENT_ERROR`: O ciclo de assinatura não foi executado devido a um erro no pagamento. <br /> `SKIPED` (escrito desta maneira): Uma execução de ciclo de assinatura foi ignorada e a assinatura será executada no próximo ciclo. <br /> `SUCCESS_WITH_NO_ORDER`: Um ciclo de assinatura foi executado com sucesso e o pedido atrelado não possui itens. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: Um ciclo de assinatura foi executado com sucesso e possui um pedido parcial atrelado. <br /> `RE_TRIGGERED`: Uma re-execução de ciclo da assinatura foi acionada manualmente. <br /> `SCHEDULE_UPDATED`: A data da próxima execução de ciclo da assinatura foi atualizada. |\n| Has Active Items | Informa se a assinatura tem itens ativos. <br /> `TRUE`: Tem itens ativos. <br /> `FALSE`: Não tem itens ativos. |\n| Is Skipped | Informa se o ciclo da assinatura será pulado. <br /> `TRUE`: O ciclo será pulado. <br /> `FALSE`: O ciclo não será pulado. |\n| Next Purchase Date | Data da próxima compra. |\n| Last Purchase Date | Data da última compra. |\n| Periodicity | Periodicidade da assinatura. |\n| Interval | Intervalo da assinatura. |\n| Purchase Day | Dia da compra da assinatura. |\n| AddressId | ID do endereço do cliente. |\n| AddressType | Tipo do endereço. |\n| PaymentSystem Name | Tipo de pagamento da assinatura. |\n| Account Id | ID da conta. |\n| Selected Sla | O [Service Level Agreement (SLA)](https://vtex.com/pt-br/trust/contratos) escolhido. |\n| Cycle | Número que identifica o ciclo da assinatura. |\n| Created At | Data de criação da assinatura. |\n| Last Update | Última atualização da assinatura. |\n| Subscriptions Items Count | Contagem de itens da assinatura. |\n| Subscriptions Item Id | ID dos itens da assinatura. |\n| Subscriptions Item Status | Status dos itens da assinatura. |\n| Subscriptions Item Sku Id | SKU dos itens da assinatura. |\n| Subscriptions Item PriceAtSubscriptionDate | Valor dos itens no momento da assinatura. |\n| Subscriptions Item Quantity | Quantidade de itens na assinatura. |\n| Subscriptions Item Is Skipped | Informa se os itens serão pulados. <br /> `TRUE`: Os itens serão pulados. <br /> `FALSE`: Os itens não serão pulados. |\n| Subscriptions Item Cycle | Ciclo dos itens da assinatura. |\n| Subscriptions Item OriginalOrder | Pedido original dos itens da assinatura. |\n\n## Assinaturas atualizadas entre datas\n\nO relatório `subscriptionsUpdatedBetweenDate` retorna dados de assinaturas atualizadas entre um período de datas.\n\nAs colunas correspondem a uma informação específica sobre a assinatura, conforme descrito abaixo.\n\n| **Nome do campo** | **Descrição** |\n| :---: | :--- |\n| ID | ID da assinatura. |\n| Customer Email | Email do cliente. |\n| Customer Id | ID do cliente. |\n| Status | Status da assinatura no momento de gerar o relatório. <br /> `TRIGGERED`: Uma execução do ciclo de assinatura foi acionada. <br /> `IN_PROCESS`: A assinatura está sendo processada pelo sistema (status temporário). <br /> `FAILURE`: Ocorreu um erro interno na execução da assinatura. <br /> `SUCCESS`: O ciclo de assinatura foi processado com sucesso. <br /> `EXPIRED`: A assinatura não foi renovada e ultrapassou a data limite vigente. <br /> `ORDER_ERROR`: O ciclo de assinatura não foi executado devido a um erro no _place order_ do pedido. <br /> `PAYMENT_ERROR`: O ciclo de assinatura não foi executado devido a um erro no pagamento. <br /> `SKIPED` (escrito desta maneira): Uma execução de ciclo de assinatura foi ignorada e a assinatura será executada no próximo ciclo. <br /> `SUCCESS_WITH_NO_ORDER`: Um ciclo de assinatura foi executado com sucesso e o pedido atrelado não possui itens. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: Um ciclo de assinatura foi executado com sucesso e possui um pedido parcial atrelado. <br /> `RE_TRIGGERED`: Uma re-execução de ciclo da assinatura foi acionada manualmente. <br /> `SCHEDULE_UPDATED`: A data da próxima execução de ciclo da assinatura foi atualizada. |\n| Has Active Items | Informa se a assinatura tem itens ativos. <br /> `TRUE`: Tem itens ativos. <br /> `FALSE`: Não tem itens ativos. |\n| Is Skipped | Informa se o ciclo da assinatura será pulado. <br /> `TRUE`: O ciclo será pulado. <br /> `FALSE`: O ciclo não será pulado. |\n| Next Purchase Date | Data da próxima compra. |\n| Last Purchase Date | Data da última compra. |\n| Periodicity | Periodicidade da assinatura. |\n| Interval | Intervalo da assinatura. |\n| Purchase Day | Dia da compra da assinatura. |\n| AddressId | ID do endereço do cliente. |\n| AddressType | Tipo do endereço. |\n| PaymentSystem Name | Tipo de pagamento da assinatura. |\n| Account Id | ID da conta. |\n| Selected Sla | O [Service Level Agreement (SLA)](https://vtex.com/pt-br/trust/contratos) escolhido. |\n| Cycle | Número que identifica o ciclo da assinatura. |\n| Created At | Data de criação da assinatura. |\n| Last Update | Última atualização da assinatura. |\n| Subscriptions Items Count | Contagem de itens da assinatura. |\n| Subscriptions Item Id | ID dos itens da assinatura. |\n| Subscriptions Item Status | Status dos itens da assinatura. |\n| Subscriptions Item Sku Id | SKU dos itens da assinatura. |\n| Subscriptions Item PriceAtSubscriptionDate | Valor dos itens no momento da assinatura. |\n| Subscriptions Item Quantity | Quantidade de itens na assinatura. |\n| Subscriptions Item Is Skipped | Informa se os itens serão pulados. <br /> `TRUE`: Os itens serão pulados. <br /> `FALSE`: Os itens não serão pulados. |\n| Subscriptions Item Cycle | Ciclo dos itens da assinatura. |\n| Subscriptions Item OriginalOrder | Pedido original dos itens da assinatura. |\n\n## Assinaturas criadas entre datas\n\nO relatório `subscriptionsCreatedBetweenDate` retorna dados de assinaturas criadas entre um período de datas.\n\nAs colunas correspondem a uma informação específica sobre a assinatura, conforme descrito abaixo.\n\n| **Nome do campo** | **Descrição** |\n| :---: | :--- |\n| ID | ID da assinatura. |\n| Customer Email | Email do cliente. |\n| Customer Id | ID do cliente. |\n| Status | Status da assinatura no momento de gerar o relatório. <br /> `TRIGGERED`: Uma execução do ciclo de assinatura foi acionada. <br /> `IN_PROCESS`: A assinatura está sendo processada pelo sistema (status temporário). <br /> `FAILURE`: Ocorreu um erro interno na execução da assinatura. <br /> `SUCCESS`: O ciclo de assinatura foi processado com sucesso. <br /> `EXPIRED`: A assinatura não foi renovada e ultrapassou a data limite vigente. <br /> `ORDER_ERROR`: O ciclo de assinatura não foi executado devido a um erro no _place order_ do pedido. <br /> `PAYMENT_ERROR`: O ciclo de assinatura não foi executado devido a um erro no pagamento. <br /> `SKIPED` (escrito desta maneira): Uma execução de ciclo de assinatura foi ignorada e a assinatura será executada no próximo ciclo. <br /> `SUCCESS_WITH_NO_ORDER`: Um ciclo de assinatura foi executado com sucesso e o pedido atrelado não possui itens. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: Um ciclo de assinatura foi executado com sucesso e possui um pedido parcial atrelado. <br /> `RE_TRIGGERED`: Uma re-execução de ciclo da assinatura foi acionada manualmente. <br /> `SCHEDULE_UPDATED`: A data da próxima execução de ciclo da assinatura foi atualizada. |\n| Has Active Items | Informa se a assinatura tem itens ativos. <br /> `TRUE`: Tem itens ativos. <br /> `FALSE`: Não tem itens ativos. |\n| Is Skipped | Informa se o ciclo da assinatura será pulado. <br /> `TRUE`: O ciclo será pulado. <br /> `FALSE`: O ciclo não será pulado. |\n| Next Purchase Date | Data da próxima compra. |\n| Last Purchase Date | Data da última compra. |\n| Periodicity | Periodicidade da assinatura. |\n| Interval | Intervalo da assinatura. |\n| Purchase Day | Dia da compra da assinatura. |\n| AddressId | ID do endereço do cliente. |\n| AddressType | Tipo do endereço. |\n| PaymentSystem Name | Tipo de pagamento da assinatura. |\n| Account Id | ID da conta. |\n| Selected Sla | O [Service Level Agreement (SLA)](https://vtex.com/pt-br/trust/contratos) escolhido. |\n| Cycle | Número que identifica o ciclo da assinatura. |\n| Created At | Data de criação da assinatura. |\n| Last Update | Última atualização da assinatura. |\n| Subscriptions Items Count | Contagem de itens da assinatura. |\n| Subscriptions Item Id | ID dos itens da assinatura. |\n| Subscriptions Item Status | Status dos itens da assinatura. |\n| Subscriptions Item Sku Id | SKU dos itens da assinatura. |\n| Subscriptions Item PriceAtSubscriptionDate | Valor dos itens no momento da assinatura. |\n| Subscriptions Item Quantity | Quantidade de itens na assinatura. |\n| Subscriptions Item Is Skipped | Informa se os itens serão pulados. <br /> `TRUE`: Os itens serão pulados. <br /> `FALSE`: Os itens não serão pulados. |\n| Subscriptions Item Cycle | Ciclo dos itens da assinatura. |\n| Subscriptions Item OriginalOrder | Pedido original dos itens da assinatura. |\n\n## Assinaturas executadas entre datas\n\nO relatório `executionsBetweenDate` retorna dados de assinaturas executadas entre um período de datas.\n\nAs colunas correspondem a uma informação específica sobre a assinatura, conforme descrito abaixo.\n\n| **Nome do campo** | **Descrição** |\n| :---: | :--- |\n| Id | ID da assinatura. |\n| OrderGroup | ID do pedido gerado pela execução do relatório. |\n| E-mail | Email do cliente. |\n| Customer Id | ID do cliente. |\n| Skus | SKUs dos produtos da assinatura. |\n| Order | Número do pedido. |\n| Value | Valor da assinatura. |\n| cycleCount | Número que identifica o ciclo da assinatura. |\n| date | Data de criação da assinatura. |\n| IsInRetry | Informa se uma nova tentativa pode ser feita ou se o ciclo da assinatura terminou. <br /> `TRUE`: A assinatura ainda está no ciclo de retry e há tentativas pendentes. <br /> `FALSE`: O ciclo da assinatura terminou. |\n| Status | Status da assinatura no momento da execução do relatório. <br /> `TRIGGERED`: Uma execução do ciclo de assinatura foi acionada. <br /> `IN_PROCESS`: A assinatura está sendo processada pelo sistema (status temporário). <br /> `FAILURE`: Ocorreu um erro interno na execução da assinatura. <br /> `SUCCESS`: O ciclo de assinatura foi processado com sucesso. <br /> `EXPIRED`: A assinatura não foi renovada e ultrapassou a data limite vigente. <br /> `ORDER_ERROR`: O ciclo de assinatura não foi executado devido a um erro no _place order_ do pedido. <br /> `PAYMENT_ERROR`: O ciclo de assinatura não foi executado devido a um erro no pagamento. <br /> `SKIPED` (escrito desta maneira): Uma execução de ciclo de assinatura foi ignorada e a assinatura será executada no próximo ciclo. <br /> `SUCCESS_WITH_NO_ORDER`: Um ciclo de assinatura foi executado com sucesso e o pedido atrelado não possui itens. <br /> `SUCCESS_WITH_PARTIAL_ORDER`: Um ciclo de assinatura foi executado com sucesso e possui um pedido parcial atrelado. <br /> `RE_TRIGGERED`: Uma re-execução de ciclo da assinatura foi acionada manualmente. <br /> `SCHEDULE_UPDATED`: A data da próxima execução de ciclo da assinatura foi atualizada. |\n| messageParsed | Mensagem retornada pelo checkout durante a execução da assinatura. |\n| CreatedAt | Data da criação da assinatura. |\n| LastUpdate | Data da última atualização da assinatura. |\n| ActiveSkus | SKUs ativos na assinatura. |"}