Recurrence - Cobranças recorrentes
A recorrência possui o papel de viabilizar a cobrança num intervalo específico definido pelo cliente de acordo com o plano de recorrência escolhido. Desta forma, o lojista fica livre da obrigação de todo mês ter que criar uma nova cobrança manual, que geraria oneração desnecessária de tempo. Com as cobranças recorrentes, o lojista que trabalha com aluguéis de itens ou até mesmo serviços mensais podem criar suas cobranças e definir o intervalo, valor, início e finalização daquela nova recorrência.
Atualmente existem os seguintes endpoints que encontram-se disponíveis para utilização:
Método: PUT
/v2/Orders/{merchantOrderId}/Recurrences/Plan - Altera o plano de recorrência atual
/v2/Orders/{merchantOrderId}/Recurrences/PaymentMethod - Altera o método de pagamento atual
/v2/Orders/{merchantOrderId}/Recurrences/EndDate - Altera a data final da referida recorrência
/v2/Orders/{merchantOrderId}/Recurrences/Deactivate - Desativa a recorrência desejada
/v2/Orders/{merchantOrderId}/Recurrences/Activate - Ativa/reativa a recorrência desejada
Método: GET
/v2/Orders/{merchantOrderId}/Recurrences - Localiza uma recorrência através do MerchantOrderId
/v2/Orders/{merchantOrderId}/Recurrences/Bill/{referenceId}/PDF - Localiza e disponibiliza para download a fatura relacionada ao MerchantOrderId e ReferenceId inseridos na requisição
/v2/Orders/{merchantOrderId}/Recurrences/Bill/{referenceId} - Traz os dados via API referentes à fatura utilizando o referenceId
Método: POST
/v2/Orders/{merchantOrderId}/Recurrences/sendBill - Envia a fatura para o e-mail informado
Método: PATCH
/v2/Orders/{merchantOrderId}/Recurrences/{recurrenceToken}/Customer - Edita as informações de um customer