This API call lets 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
| 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 |
