The Hotmart subscription service consists of recurring charges that are programmed and processed by HotPay.
This endpoint cancels a subscription, interrupts the charge cycle, and notifies the cancellation of the subscription for sub-systems such as Club and Webhook.
It is an exclusive subscriber code.
Indicates whether to send a cancellation notification email to the buyer. It sends an email if you mark it as true, or it doesn't send it if you mark it as false.
Current subscription status, which can be:
Shows if there was an error processing a subscription list. For example, if the Producer sets up a mass cancellation of their subscriptions and one of these cancellations is not processed correctly, an error message is returned.
Exclusive code for a subscriber, who may not even be the same person who purchased the subscription.
Date of subscription creation.
Number of the current recurrence. For example, if you have a monthly subscription, as soon as you subscribe and pay for the first recurrence, this is recurrence number 1. The value of this attribute will increase as new recurrences are paid over time.
Date of the last payment.
Next payment attempt date.
Day on which charges are made. For monthly or annual subscriptions, it means the day of the month. For weekly subscriptions, it means the day of the week being:
Number of days that the subscription offers as a trial period. After this period, the first charge will be made.
Time interval between the charges for a subscription. In the following formats:
Number of charges depending on the type. Ex: if
interval_type_between_charges is equal to
MONTH, it means that it is monthly and if
interval_between_charges is equal to
3, it means that the charge is quarterly.
Number of recurrences configured for the plan. If the value is equal to
0, it means that there is no limit of recurrences, that is, the Producer (a) configured the option" until the customer cancels ".
Date of subscription activation.
User responsible for paying the subscription.