Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Recurring »

View a Subscription

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

Request Fields

Field Name Type Required Description
action String Yes subscriptionView
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
subscriptionId Integer Yes The subscription ID.

Response Fields (XML)

Field Name Type Description
subscriptions - XML structure
subscription - XML structure
id Integer The subscription ID.
customer - XML structure
customerCode String The customer code.
businessName String The business name.
contactName String The contact name.
customer - XML structure.
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.
amountRecurring Decimal The recurring amount.
cyclesBilled Integer The number of cycles already billed.
cyclesTotal Integer The total number of cycles in the plan.
upcomingRevenue - XML structure
setupRevenue Decimal The setup cost.
recurringRevenue Decimal The recurring revenue.
addOnRevenue Decimal The add on revenue.
taxRevenue Decimal The tax revenue.
totalRevenue Decimal The total revenue.
proRata Integer 1 or 0. Whether or not the subscription plan can be prorated.
upcomingRevenue - XML structure
addOns - XML structure


For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description
0 - Invalid Subscription ID The subscription ID provided was invalid, or not entered.

Code Samples

Sample Subscription View Response XML

<?xml version="1.0"?>
        <dateCreated>2017-04-15 16:33:27</dateCreated>
        <dateStarted>2017-07-01 00:00:00</dateStarted>
        <dateRemoved>2018-07-01 00:00:00</dateRemoved>

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="subscriptionView">
<input type="hidden" name="subscriptionId" value="3215">