Background - API1Created with Sketch.

Suscripciones

El servicio de suscripciones de Hotmart es un modo de realizar cobros recurrentes programados y procesados por HotPay.

Cancelar suscripción

Este endpoint efectúa la cancelación de una suscripción, interrumpe el ciclo de cobros y les notifica la cancelación de la suscripción a subsistemas como Club y Webhook.

Parámetros de la solicitud

Path

  • subscriber_codestringgeneral.required

    Es el código exclusivo de un suscriptor.

Body

  • send_mailboolean

    Indica si hay que enviarle un email de notificación de cancelación al comprador. Envía el email si lo marcas como true, o no lo manda si lo marcas como false.


Retorno

  • statusstring

    Estatus actual de la suscripción, que puede ser:

    ACTIVE ou INACTIVE

  • subscriber_codestring

    Código exclusivo de un suscriptor, que puede incluso no ser la misma persona que ha realizado la compra de la suscripción.

  • creation_datestring

    Fecha de creación de la suscripción.

  • current_recurrenceinteger

    Número de la recurrencia actual. Por ejemplo, si tienes una suscripción mensual, cuando te suscribes y pagas la primera recurrencia, esta es la recurrencia número 1. El valor de este atributo aumentará a medida que nuevas recurrencias sean pagas con el pasar del tiempo.

  • date_last_recurrencestring

    Fecha del último pago.

  • date_next_chargestring

    Data de tentativa do próximo pagamento.

  • due_dayinteger

    Día en que los cobros son realizados. Para suscripciones mensuales o anuales, significa el día del mes. Para suscripciones semanales, significa el día de la semana siendo:

    1-lunes, 2-martes, 3-miércoles, 4-jueves, 5-viernes, 6-sábado o 7-domingo

  • trial_periodinteger

    Cantidad de días que la suscripción se queda disponible como período de prueba. Luego de este período, el primer cobro será realizado.

  • interval_type_between_chargesstring

    Intervalo de tiempo entre los cobros de una suscripción. En los siguientes formatos:

    DAY, WEEK, MONTH ou INVOICE.

  • interval_between_chargesinteger

    Número de cobros de acuerdo con el tipo. Ej: si interval_type_between_charges es igual a MONTH, significa que es mensual y si interval_between_charges es igual a 3, significa que el cobro es trimestral.

  • max_charge_cyclesinteger

    Cantidad de recurrencias configuradas para el plan. Si el valor es igual a 0, significa que no hay límite de recurrencias, o sea, el(la) Productor(a) configuró la opción "hasta el cliente cancelar".

  • activation_datestring

    Fecha de activación de la suscripción.

  • shopperobject

    Usuario responsable por el pago de la suscripción.

    general.showParameters

Sandbox

isPageUseful.question