Gerenciamento de assinaturas
Por meio do gerenciamento de assinaturas é possível pausar, cancelar ou reativar uma assinatura já criada, além de realizar outras alterações específicas dentro de suas configurações iniciais.
Na tabela abaixo você encontra mais informações sobre as possibilidades de gerenciamento.
| Tipo | Descrição |
| Buscar assinatura | Permite buscar as assinaturas independentemente do seu status (ativa, pausada, cancelada). Para isso, envie um GET com os parâmetros necessários ao endpoint /preapproval/search e execute a requisição. |
| Alterar valor | Permite alterar o valor de uma assinatura existente. Para isso, envie um PUT com os parâmetros auto_recurring.transaction_amount, especificando o novo valor a ser cobrado na assinatura, e auto_recurring.currency_id, indicando o identificador da moeda utilizada no pagamento, para o endpoint /preapproval/{id}. Em seguida, execute a requisição. |
| Alterar cartão do meio de pagamento primário | Permite alterar o cartão associado à uma assinatura existente. Para isso, envie um PUT com o novo token (no atributo card_token_id) ao endpoint /preapproval/{id} e execute a requisição. |
| Alterar meio de pagamento secundário | Permite adicionar um segundo meio de pagamento à uma assinatura existente. Se for um cartão, envie um PUT com os parâmetros card_token_id_secondary e payment_method_id_secondary ao endpoint /preapproval/{id} e execute a requisição. Para outros meios de pagamento, envie apenas o parâmetro payment_method_id_secondary e siga com a operação. |
| Cancelar ou pausar assinatura | Possibilita cancelar ou pausar uma assinatura existente. Para isso, envie um PUT com o atributo status e o valor cancelled ao endpoint /preapproval/{id} e execute a requisição. E para pausar uma assinatura envie um PUT com o atributo status e o valor paused ao mesmo endpoint e execute a requisição. |
| Reativar uma assinatura | Permite reativar uma assinatura pausada e definir uma data limite para sua conclusão. Para isso, envie um PUT com os parâmetros necessários para o endpoint /preapproval/{id} e execute a solicitação. |
| Alterar data de cobrança | Para assinaturas com frequência de pagamento mensal, você pode escolher um dia fixo do mês para que ocorram as cobranças. Para isso, envie um PUT com os parâmetros necessários ao endpoint /preapproval/{id} e execute a requisição. |
| Definir valor proporcional | É possível definir um valor proporcional para a cobrança de determinada assinatura. Para isso, envie um PUT com os parâmetros necessários ao endpoint /preapproval/{id} e execute a requisição. |
| Oferecer teste grátis | É possível oferecer um período de teste grátis para que os clientes possam testar o produto e/ou serviço antes de adquiri-lo. Para isso, envie um PUT com parâmetro free_trial, frequency e frequency_type com a quantidade de dias e o tipo (dias/meses) ao endpoint /preapproval_plan/{id} e execute a requisição. |