Helcim Logo Support & Tutorials

© Copyright 2006-2019 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Recurring »

Queue a Recurring Plan for Processing

This API call let's you queue a recurring plan for processing. The response is an XML of the available recurring plan information.

Request Fields

Field Name Type Required Description
action String Yes recurringPlanQueue
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.

Response Fields (XML)

Field Name Type Description
message - XML structure
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.

Code Samples

Sample Recurring Plan Queue Response XML

<?xml version="1.0"?>
    <responseMessage>Recurring Plan is now Queue for Processing</responseMessage>

HTML Form Sample HTML

<input type="hidden" name="accountId" value="YOUR-ACCOUNT-ID">
<input type="hidden" name="apiToken" value="YOUR-API-TOKEN">
<input type="hidden" name="action" value="recurringPlanView">
<input type="hidden" name="recurringPlanId" value="500">