Skip to main content (Press Enter)
Helcim Logo
Click here if you return to contents

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.

You can access the Recurring Plan ID by clicking on the recurring plan you want to use under Recurring and then Recurring Plans, the plan ID is located at the end of the URL for the plan in your browser window.

Response Fields

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.

Errors

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.

Related Articles

View a Recurring Plan
Add or Edit a Subscription
View a Subscription
Subscription List

Was this article helpful?

Feedback submitted - Thank you!
Click here if you return to the content