Background - API1Created with Sketch.

Subscriptions

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

Reactivate and Charge Subscription

This endpoint reactivates an inactive subscription , you'll be able to choose whether a new charge will be issued after the process.

Request parameters

Path

  • subscriber_codearraygeneral.required

    Unique subscriber code whose subscription you want to reactivate.

Body

  • chargeboolean

    Indicates whether to charge buyers again when reactivating subscriptions. It generates a new charge if you mark it as true, by default its value is false. The billing date will remain the same as before the subscription was deactivated.


Return

  • statusstring

    Current subscription status, which can be:

    ACTIVE or INACTIVE

  • subscriber_codestring

    Subscriber's unique code, which may be a different person from the one who purchased the subscription.

  • creation_datestring

    Date subscription was created.

  • current_recurrenceinteger

    Current recurrence number. 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 overtime.

  • date_last_recurrencestring

    Date of the last payment.

  • date_next_chargestring

    Date of the next payment attempt.

  • due_dayinteger

    The day when 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:

    1-Monday, 2-Tuesday, 3-Wednesday, 4-Thursday, 5-Friday, 6-Saturday or 7-Sunday

  • trial_periodinteger

    Number of days that the subscription offers as a trial period. After this period, the first charge will be made.

  • interval_type_between_chargesstring

    Time period between charges for a subscription. In the following formats:

    DAY, WEEK, MONTH or INVOICE.

  • interval_between_chargesinteger

    Number of charges according to type. E.g.: 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.

  • max_charge_cyclesinteger

    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 has set the option "until the customer cancels ".

  • activation_datestring

    Date subscription was activated.

  • shopperobject

    User responsible for paying the subscription.

    general.showParameters

Sandbox

isPageUseful.question