/svc/payment/api/v1/openapi/recurring_payments/plan/calculateCalculate a plan
Use this interface to calculate a new recycling plan
- If there are identical reference_numbers when creating a recycling plan, you will be informed: “plan has been created”
- Multiple recurring_cycle can be created with this API in succession
- The next_billing_amount of the first recurring_cycles is the total amount of the order to be generated, with discount and proration deduction alrerady included.
Header parameters
Example: {{appid}}
Example: TRUE
Example: good
Example: {{credential}}
Example: {{$string.uuid}}
Example: zh-CN
Example: application/json
Request body · application/json
This is name of the recurring plan (ex: Plan A)
This is transferred to return the note for all related recurring orders
Any description to remark about this record
This field is to count the day period that after the final attempt of payment charge is unsuccessful, then how many more days until the system will void the recurring_order record. Then change the status to recurring_cycles.state = uncollectible. If grace_period = NULL , then the system will never void the recurring_orders record
This field is to generate the reference number for the connecting orders created by the recurring plan - Every new order created under this recurring plan will have the same “reference number” with incremental suffix
This is to set the limit how many attempts to be executed. Once the count limit has reached, then the system will change the status to recurring_cycles.state = uncollectible
Once the initial payment request attempt is unsuccessful, the system will wait until the next given period data specified in payment_retry_day_period (ex: 1 day). Once the specified day period has reached, then the system will pose another charge attempt to the recurring order.
Single option choice: [charge_automatically] - automatically charge the customer provided card details