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
| 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 |
Errors
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. |
