Create a plan

Recurring plan to create

This is name of the recurring plan (ex: Plan A)

This is transferred to return the note for all related recurring orders

Payment link timeout settings

Any description to remark about this record

Webhook url that receives status notifications of recurring orders under the plan

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

The redirection address after the payment link is completed

Wonder side unique id of the customer

Billing cycles of the recurring plan

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

Response code

Response data

Recurring plan details

Response message