alerts.beta
Background - API1Created with Sketch.

Subscriptions

The Hotmart subscription service consists of recurring charges that are programmed and processed by HotPay.

Get Subscribers' Purchases

This endpoint lists recurrence payments linked to a subscription. Used for listing purchases and subscriptions, being important for carrying out metrics and actions on a purchase, such as a refund.

Request parameters

Path

  • subscriber_codestringgeneral.required

    An exclusive subscriber code.


Return

  • transactionstring

    This field shows the transaction code, ex: HP17715690036014

  • approved_datedate

    Shows the day the order was approved.

  • payment_enginestring

    Shows the payment platform. For example, if it was paid using HotPay or HotPay Internacional.

  • statusstring

    Shows the purchase status, which can be:

    STARTED, PROCESSING_TRANSACTION, COMPLETE, PRINTED_BILLET, WAITING_PAYMENT, APPROVED, UNDER_ANALISYS, CANCELLED, PROTESTED, REFUNDED, CHARGEBACK, BLOCKED, OVERDUE, PRE_ORDER, NO_FUNDS or EXPIRED

    The description for each status can be found on our Customer Support page .

  • priceobject

    Shows the price information.

    general.showParameters
  • payment_typestring

    Shows the payment type, which are:

    BILLET, CREDIT_CARD, PAYPAL, BANK_DEBT, HOTMART_BALANCE, CASH_PAYMENT, SAMSUNG_PAY and GOOGLE_PAY

  • payment_methodstring

    Shows the payment method, which can be:

    BILLET, PAYPAL, BANCO_BRASIL_ONLINE_TRANSFER, BRADESCO_ONLINE_TRANSFER, ITAU_ONLINE_TRANSFER, VISA_CREDIT_CARD, MASTERCARD_CREDIT_CARD, AMERICAN_EXPRESS_CREDIT_CARD, AURA_CREDIT_CARD, DINERS_CREDIT_CARD, HIPERCARD_CREDIT_CARD, ELO_CREDIT_CARD, HOTMART, BANK_DEBT, DISCOVER_CREDIT_CARD, SEPA_DIRECT_DEBT or MULTIBANK

  • recurrency_numberinteger

    Shows the corresponding recurrence number.

  • under_warrantyboolean

    Shows if the transaction is under the guarantee.

  • purchase_subscriptionboolean

    Shows if it is a subscription product.

Sandbox

isPageUseful.question