alerts.beta
Background - API1Created with Sketch.

Assinaturas

O serviço de assinaturas da Hotmart é um modo de cobranças recorrentes que são programadas e processadas pelo HotPay.

Cancelar Assinatura

Este endpoint faz o cancelamento de uma assinatura, interrompe o ciclo de cobranças e notifica o cancelamento da assinatura para sub-sistemas como Club e Webhook.

Parâmetros da requisição

Path

  • subscriber_codestringgeneral.required

    É o código exclusivo de um assinante.

Body

  • send_mailboolean

    Indica se deve enviar email de notificação de cancelamento ao comprador. Ele manda email se você marcar como true, ou não manda se você marcar como false.


Retorno

  • statusstring

    Status atual da assinatura, que pode ser:

    ACTIVE ou INACTIVE

  • subscriber_codestring

    Código exclusivo de um assinante, que pode inclusive não ser a mesma pessoa que fez a compra da assinatura.

  • creation_datestring

    Data de criação da assinatura.

  • current_recurrenceinteger

    Número da recorrência atual. Por exemplo, se você tem uma assinatura mensal, assim que você assina e paga a primeira recorrência, esta é a recorrência número 1. O valor deste atributo aumentará à medida que novas recorrências forem pagas com o passar do tempo.

  • date_last_recurrencestring

    Data do último pagamento.

  • date_next_chargestring

    Data de tentativa do próximo pagamento.

  • due_dayinteger

    Dia em que as cobranças são feitas. Para assinaturas mensais ou anuais, significa o dia do mês. Para assinaturas semanais, significa o dia da semana sendo:

    1-segunda, 2-terça-feira, 3-quarta-feira, 4-quinta-feira, 5-sexta-feira, 6-sábado ou 7-domingo

  • trial_periodinteger

    Quantidade de dias que a assinatura disponibiliza como período de teste. Após este período, a primeira cobrança será realizada.

  • interval_type_between_chargesstring

    Intervalo de tempo entre as cobranças de uma assinatura. Nos seguintes formatos:

    DAY, WEEK, MONTH ou INVOICE.

  • interval_between_chargesinteger

    Número de cobranças de acordo com o tipo. Ex: se interval_type_between_charges for igual a MONTH, significa que ela é mensal e se interval_between_charges for igual a 3, significa que a cobrança é trimestral.

  • max_charge_cyclesinteger

    Quantidade de recorrências configuradas para o plano. Se o valor for igual a 0, significa que não há limite de recorrências, ou seja, o(a) Produtor(a) configurou a opção "até o cliente cancelar".

  • activation_datestring

    Data de ativação da assinatura.

  • shopperobject

    Usuário responsável pelo pagamento da assinatura.

    general.showParameters

Sandbox

isPageUseful.question