Suspender, Ativar e Remover Assinaturas

📘

O que você irá aprender com esse artigo?

  • Como suspender uma assinatura
  • Como ativar uma assinatura
  • Como remover uma Assinatura

Como suspender uma assinatura

Caso de Uso
“Cliente não deseja mais seguir com sua assinatura e solicita a suspensão.”

Diagrama de sequência

Para que o cliente não seja cobrado nos próximos ciclos de sua assinatura, é possível suspendê-la ao invés de remover a assinatura permanentemente.
Neste cenário, é possível reativar a assinatura futuramente caso o cliente solicite.

Para realizar a suspensão via API, é preciso realizar um POST na Endpoint de “Suspender Assinatura” https://api.iugu.com/v1/subscriptions/{id}/suspend, informando o parâmetro id da Assinatura.

Exemplo de request

curl --location --request POST 'https://api.iugu.com/v1/subscriptions/{{id_subscription}}/suspend?api_token={{api_token}}' \
--header 'Cookie: __cfruid=e245288b389fed8ddeab4d36894ae9d85d6ccc19-1634834882'

Exemplo de response

Como ativar uma assinatura

Caso de Uso
“Cliente deseja reativar sua assinatura e solicita a ativação.”

Diagrama de Sequência

Caso o cliente desejar reativar sua assinatura é possível somente quando ela está com status “suspensa”.

Para este cenário, é preciso realizar um POST na Endpoint de “Ativar Assinatura” https://api.iugu.com/v1/subscriptions/{id}/activate informando o parâmetro de id da assinatura.

Exemplo de Request

curl --request POST \
     --url 'https://api.iugu.com/v1/subscriptions/{{id_subscriptions}}/activate?api_token={{api_token}} \
     --header 'Accept: application/json'

Exemplo de Response

Como remover assinatura

Caso de uso
"Cliente solicita a exclusão de sua assinatura por definitivo."

Diagrama de Sequência

Para este cenário, é preciso realizar um DELETE na Endpoint de “Remover Assinatura” https://api.iugu.com/v1/subscriptions/{id} informando o parâmetro de id da assinatura.

Exemplo de Request

curl --location --request DELETE 'https://api.iugu.com/v1/subscriptions/E1AB9B4EA67D4F8B982E92BABB106052?api_token={{api_token}}' \
--header 'Cookie: __cfruid=45d3c132585d9d277025a56502dc3fb5016073f9-1634913572' \
--data-raw ''

Exemplo de Response


Did this page help you?