Configuration Steps

1- First, you will need to visit TPAY dashboard and log in using your credentials.

2- Open subscription tab

3- Choose Add/Edit subscription plan.

4- Fill subscription plan details:

  • Subscription Name
  • Subscription frequency: it is the frequency of the subscription plan and it can be daily or weekly or monthly or yearly.
  • Charging Failure retrials: should be allowed, and you can set the number of charging retrials and choose the time gap between the retrials.
  • Note: Charging retrials can’t be more than 1 retrial per day, so for daily packages, only one retrial is allowed.
  • Enable the subscription plan to be able to use this plan.
  • Suspend After Bill Collection Failure: If TPAY fails to collect the bill (recurring and retrials) from the subscriber, the subscription contract status will be changed to “suspended,” and the partner will be notified by a status change notification through the push notification URL configured below (Recommendation: uncheck to avoid losing subscribers).
  • Override Subscription Notification URL: Enable this flag if you want to configure the Subscription push Notification URL from inside the plan (Recommendation: check and configure partner push notification URL below).
  • Enter your Subscription push Notification full URL (with HTTP(S)://): Partners should configure the notification URL to receive push notifications from TPAY about contract status changes and recurring payment status. (Find samples of push notifications in this article)
  • Note: You can define different Subscription push Notification URL per subscription plan.
  • Enable Reset Billing Cycle: Resets the next payment date after X number of trials (see sample below).
  • Reset Billing Cycle After Trial Number: It must be less than or equal to the retrials count.

Example: If you are using a weekly plan and setting the retrials count = 5 (1 per day) and Reset Billing Cycle After Trial Number = 4 (it must be less than or equal to the retrials count).

If you added subscription contract X on this plan, and the bill due date for this contract (Next payment date) is 10-7-2024, TPAY will try to charge them. For example, if all the retrials failed except the 5th retrial, the successful charging date is 15-7-2024.

  • If the Reset Billing Cycle After Trial Number flag is enabled: The next payment date for this contract will be 22-7-2024, which is after 7 days (a week) from the actual charging date of 15-7-2024.
  • If the Reset Billing Cycle After Trial Number flag is disabled: The next payment date for this contract will be 17-7-2024, which is after 7 days (a week) from the bill due date of 10-7-2024.

5- Click on the Save Changes button, and the new subscription plan will be added successfully, with the option to edit or delete it.