Queue a Recurring Plan for Processing
This API call lets you queue a recurring plan for processing. The response is an XML of the available recurring plan information.
|accountId||Integer||Yes||The Helcim Commerce account ID.|
|apiToken||String||Yes||API token used for authentication and access control.|
|recurringPlanId||Integer||Yes||The recurring plan ID.|
You can access the Recurring Plan ID by clicking on the recurring plan you want to use under
Recurring Plans, the plan ID is located at the end of the URL for the plan in your browser window.
|response||Integer||1 or 0. Whether the recurring plan was queued for processing or not.|
|responseMessage||String||Confirmation of action taken.|
For all API requests, there are also generic API authentication and user access restriction errors.
|Response Code||Error Code||Message||Description|
|0||-||Automatic Recurring Must be Disactivated in Order to Manually Trigger Recurring||The recurring plan cannot be automatically recurring.|
|0||-||Invalid Recurring Plan ID||The plan ID provided was invalid, or not entered.|