We have added a new feature in Telgoo5 that allows you to charge prorated amounts for plan purchases, changes, or renewals when these actions occur mid-month.
What is Proration?
Proration means adjusting the cost of a plan based on the number of days left in the billing cycle. For example, if a customer changes their plan in the middle of the month, they will only be charged for the remaining days of the billing cycle.
How to Enable Proration
To enable proration in your Telgoo5 system, follow these steps:
- Go to System Config (PC234) and enable the Proration setting.
- Navigate to Plan Change/Renew Config and set Allow Prepaid Billing From Plan Config (SC1491) to "Yes."
- Log out and log back in for the changes to take effect.
- Go to Plan Config (PC232) to enable proration for the specific plans you want.
- Select the plan you want to update and click Edit.
- Set Is Prorated Plan to "Yes."
- Choose when you want proration to apply. The available options are:
- New Activation: The plan price will be prorated if a new line is added mid-billing cycle.
- Plan Change: The plan price will be prorated if the plan is changed or renewed mid-month.
- Disconnect: If an account is disconnected mid-cycle, a prorated credit will be applied to the customer's account.
API Functionality
If you’ve enabled proration for a plan, adding a new line using the create_customer_prepaid_multiline
API does not require any changes—the system will automatically apply proration based on the plan’s settings.
However, if you are changing or renewing a plan using the change_plan
API, you need to include the change_type parameter.
- IMMEDIATE: The plan change or renewal happens immediately, and the price is prorated.
- ONEXPIRY: The plan change or renewal happens at the end of the current plan's billing cycle, and proration will not apply.
By default, the system assumes instant if the field is left blank.
If you are using the payment_details
or make_payment
APIs for plan changes or renewals, ensure that following changes are applied correctly.