alerts.beta
Background - API1Created with Sketch.

Subscriptions

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

Get subscriptions

This endpoint displays the detailed information of the producer's subscriptions/subscribers. Used for listing subscriptions and detailed information for them.

Request parameters

Query

  • max_resultsinteger

    The maximum number of items per page that can be returned.

  • page_tokenstring

    The cursor used in pagination. It is a reference to the part you want to go to on the list.

    For example, you make a request that returns 50 items, but the total number of items is 95. Adding the query param page_token with the attribute value next_page_token, you will access the 45 remaining. In the next request, changing the page_token for the value of prev_page_token, you will access the previous 50 items again.

  • product_idlong

    Shows the ID (it is a 7-digit number) of your subscription product.

  • planarray containing strings

    Shows the name of the plan to which the subscriber has selected. This attribute can receive multiple values, as long as the user repeats their key in the request with different values.

  • accession_datelong

    Shows the start date of the subscription. If no value is entered, the current date minus 30 days will be considered. The date must be in milliseconds, from 1970-01-01 00:00:00 UTC.

  • end_accession_datelong

    Shows the end date of the subscription. If no value is entered, the current date minus 30 days will be considered. The date must be in milliseconds, from 1970-01-01 00:00:00 UTC.

  • statusstring

    Shows the status of the moment when that subscription is found. These statuses can be:
    ACTIVE, INACTIVE, DELAYED, CANCELLED_BY_CUSTOMER, CANCELLED_BY_SELLER, CANCELLED_BY_ADMIN, STARTED or OVERDUE

  • subscriber_codestring

    Shows the unique code of a subscriber, which might not be the same person who purchased the subscription.

  • subscriber_emailstring

    Shows the subscriber's email.

  • transactionstring

    Shows the transaction code.

  • trialboolean

    Shows whether the subscription you are looking for has a trial period or not. Some subscriptions may have a trial period at the beginning.

  • cancelation_datelong

    Subscriptions canceled starting this date

  • end_cancelation_datelong

    Subscriptions canceled up to this date


Return

  • itemsarray containing objects

    general.showParameters
    • page_infoobject

      Pagination information, with the possible data below:

      general.showParameters

Sandbox

isPageUseful.question