The Hotmart subscription service consists of recurring charges that are programmed and processed by HotPay.
This endpoint displays the detailed information of the producer's subscriptions/subscribers. Used for listing subscriptions and detailed information for them.
The maximum number of items per page that can be returned.
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.
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.
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.
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.
Shows the status of the moment when that subscription is found. These statuses can be:
Shows the unique code of a subscriber, which might not be the same person who purchased the subscription.
Shows the subscriber's email.
Shows the transaction code.
Shows whether the subscription you are looking for has a trial period or not. Some subscriptions may have a trial period at the beginning.
Subscriptions canceled starting this date
Subscriptions canceled up to this date
itemsarray containing objects
Pagination information, with the possible data below: