alerts.beta
Background - API1Created with Sketch.

Suscripciones

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

Obtener suscripciones

Este endpoint exhibe las informaciones detalladas de los suscriptores/suscripciones del Productor. Se utiliza para el listado de suscripciones e informaciones detalladas sobre las mismas.

Parámetros de la solicitud

Query

  • max_resultsinteger

    El número máximo de ítems por página que pueden ser retornados.

  • page_tokenstring

    El cursor usado en la paginación. Es una referencia de la parte de la lista donde quieres ir.

    Por ejemplo, haces un requerimiento que te retorna 50 ítems, pero el total de ítems es 95. Si añades query param page_token con el valor del atributo next_page_token, tendrás acceso a los 45 restantes. En un próximo requerimiento, si cambias page_token por el valor prev_page_token, tendrás acceso a los 50 ítems anteriores nuevamente.

  • product_idlong

    Muestra el ID (es un número de 7 dígitos) de tu Producto de suscripción.

  • planarray containing strings

    Muestra el nombre del plan al cual el(la) suscriptor(a) se ha inscrito. Este atributo puede recibir múltiples valores, para lo cual el usuario solo tiene que repetir su clave en el requerimiento con valores diferentes.

  • accession_datelong

    Muestra la fecha de inicio de la suscripción. En caso de que no se informe ningún valor, se considerará la fecha actual menos 30 días. La fecha debe estar em milisegundos, a partir de 1970-01-01 00:00:00 UTC.

  • end_accession_datelong

    Muestra la fecha de término del período de la suscripción. En caso de que no se informe ningún valor, se considerará la fecha actual. La fecha debe estar em milisegundos, a partir de 1970-01-01 00:00:00 UTC.

  • statusstring

    Muestra el estatus del momento en que se encuentra la suscripción. Estos estatus pueden ser:
    ACTIVE, INACTIVE, DELAYED, CANCELLED_BY_CUSTOMER, CANCELLED_BY_SELLER, CANCELLED_BY_ADMIN, STARTED ou OVERDUE

  • subscriber_codestring

    Muestra el código exclusivo de un(a) suscriptor(a), que puede ser una persona diferente de quien compró la suscripción.

  • subscriber_emailstring

    Muestra el email de un(a) suscriptor(a).

  • transactionstring

    Muestra el código de la transacción.

  • trialboolean

    Muestra si la suscripción que vas a buscar tiene o no período de prueba. Algunas suscripciones pueden tener un período de prueba al inicio.

  • cancelation_datelong

    Suscripciones canceladas a partir de esta fecha

  • end_cancelation_datelong

    Suscripciones canceladas hasta esta fecha


Retorno

  • itemsarray containing objects

    general.showParameters
  • page_infoobject

    Informaciones de paginación, con los posibles siguientes datos:

    general.showParameters

Sandbox

isPageUseful.question