Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Recurring »

Subscription List

This API call let's you retrieve a list of available subscriptions. The response is an XML of the available subscription information.

Request Fields

Field Name Type Required Description
action String Yes subscriptionSearch
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
status String No The status of the subscription. (Accepted values: due, expiring, trial, expired, cancelled)
customerCode String No The customer code
recurringPlanCode String No The recurring plan code
dateStartedFrom String No Format: YYYY-MM-DD
dateStartedTo String  No Format: YYYY-MM-DD
dateCreatedFrom String No Format: YYYY-MM-DD
dateCreatedTo String No Format:YYYY-MM-DD

Response Fields (XML)

Field Name Type Description
subscriptions - XML structure
subscription - XML structure
recurringPlanCode String The code of the recurring plan
customerCode String The customer code.
dateCreated String The date the subscription was created.
dateStarted String The date the subscription was started.
dateRemoved String The date the subscription was ended.
status String Active/Expired. The status of the subscription.
eft String Are EFT transfers used, Yes/No
nickname String Recurring plan nickname
amountInitial Decimal Amount charged at the start of the recurring plan
amountRecurring Decimal The recurring amount
cyclesBilled Integer The number of cycles that have been billed
cyclesTotal Integer The total number of cycles in the plan

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description
0 - Invalid Status Status sent with request is invalid
0 - No Result No subscriptions were found

Code Samples

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="subscriptionSearch">

Sample Subscription List Response XML

<?xml version="1.0"?>
<subscriptions>
    <subscription>
        <recurringPlanCode>DNTE20</recurringPlanCode>
        <customerCode>CST-2510</customerCode>
        <dateCreated>2018-05-17 14:17:49</dateCreated>
        <dateStarted>2018-05-17 00:00:00</dateStarted>
        <dateRemoved>0000-00-00 00:00:00</dateRemoved>
        <status>Active</status>
        <eft>NO</eft>
        <nickname></nickname>
        <amountInitial>10.00</amountInitial>
        <amountRecurring>20.00</amountRecurring>
        <cyclesBilled>0</cyclesBilled>
        <cyclesTotal>0</cyclesTotal>
    </subscription>
</subscriptions>