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.

Obter Assinaturas

Este endpoint exibe as informações detalhadas das assinaturas/assinantes do produtor. Utilizado para listagem de assinaturas e informações detalhadas para as mesmas.

Parâmetros da requisição

Query

  • max_resultsinteger

    O número máximo de itens por página que podem ser retornados.

  • page_tokenstring

    O cursor usado na paginação. Ele é uma referência para a parte que você quer ir na lista.

    Por exemplo, você faz uma requisição que te retorna 50 itens, mas o total de itens é 95. Adicionando o query param page_token com o valor do atributo next_page_token, você irá acessar os 45 restantes. Numa próxima requisição, trocando o page_token pelo valor do prev_page_token, você irá acessar novamente os 50 itens anteriores.

  • product_idlong

    Mostra o ID (é um número de 7 dígitos) do seu produto de assinatura.

  • planarray containing strings

    Mostra o nome do plano no qual o(a) assinante se inscreveu. Este atributo pode receber múltiplos valores, bastando apenas que o usuário repita sua chave na requisição com valores diferentes.

  • accession_datelong

    Mostra a data de início da assinatura. Caso nenhum valor seja informado será considerada a data atual menos 30 dias. A data deve estar em milissegundos, à partir de 1970-01-01 00:00:00 UTC.

  • end_accession_datelong

    Mostra a data de término do período da assinatura. Caso nenhum valor seja informado será considerada a data atual. A data deve estar em milissegundos, à partir de 1970-01-01 00:00:00 UTC.

  • statusstring

    Mostra os status do momento em que aquela assinatura se encontra. Estes status podem ser:
    ACTIVE, INACTIVE, DELAYED, CANCELLED_BY_CUSTOMER, CANCELLED_BY_SELLER, CANCELLED_BY_ADMIN, STARTED ou OVERDUE

  • subscriber_codestring

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

  • subscriber_emailstring

    Mostra o email de um assinante.

  • transactionstring

    Mostra o código da transação.

  • trialboolean

    Mostra se a assinatura que você vai buscar tem ou não período de teste. Algumas assinaturas podem ter um período de testes no início.

  • cancelation_datelong

    Assinaturas canceladas a partir desta data

  • end_cancelation_datelong

    Assinaturas canceladas até esta data


Retorno

  • itemsarray containing objects

    general.showParameters
  • page_infoobject

    Informações de paginação, com os possíveis dados abaixo:

    general.showParameters

Sandbox

isPageUseful.question