/svc/payment/api/v1/openapi/recurring_payments/plan/{id}/cyclesAdd plan cycles
Path parameters
Header parameters
Example: TRUE
Example: good
Example: {{credential}}
Example: {{$string.uuid}}
Example: zh-CN
Example: application/json
Request body · application/json
This is to count how long will the recurring cycle run for. If data is null, then consider this recurring_cycles record will run forerver.
- This is for the system to know the billing date of a cycle, once the cycle has started - If the user changes the recurring plan of a customer (upgrade/downgrade etc.), then the
- if trial_period is TRUE, it means the total amount of billing amount for this recurring_cycles record will be 0.00
- Any description to remark about this record
Immediate: The cycle to be added will start immediately and all previously-active recurring_cycles.state from the recurring plan will be updated to cancelled. Next Billing Date: The cycle to be added will start on the next billing date of the current recurring cycle. The recurring_cycles.state will be updated to completed, and all the succession recurring_cycles.state of it will be updated to cancelled. As Last Cycle: The cycle to be added will start once the current last recurring_cycles.state of recurring plan is changed to completed. If that recurring_cycles.billing_count and hence recurring_cycles.estimated_end_date are empty, the new cycle would not be added. If activate_type is not provided, the cycle would automatically be added as this value.
immediatenext_billing_dateas_last_cycle
Only applicable for activate_type = immediate. By default, we will process the current recurring billing's remaining credit and add to/ subtract from recurring_plan.credit