View a Recurring Plan
This API call lets you retrieve the details of a specific recurring plan. The response is an XML of the available recurring plan information.
Request Fields
Field Name | Type | Required | Description |
---|---|---|---|
action | String | Yes | recurringPlanView |
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
Subscription Management
and thenPlans
, the plan ID is located at the end of the URL for the plan in your browser window.
Response Fields
Field Name | Type | Description |
---|---|---|
recurringPlans | - | XML structure |
recurringPlan | - | XML structure |
dateCreated | String | The date the plan was created. |
dateLastBilled | String | The date of the last billing. |
dateStarted | String | The date the recurring plan started. |
dateNextBilling | String | The date the next payment is billed. |
status | Integer | 1 or 0. Whether or not the recurring plan is active or not. |
name | String | The recurring plan name. |
code | String | The recurring plan code. |
token | String | The recurring plan token |
description | String | The recurring plan description. |
cyclesCount | Integer | The number of cycles billed. |
period | String | The recurring plan billing period. |
trialPeriodDays | String | The recurring plan trial period. |
trialAutoSubscribe | Integer | 1 or 0. Whether the trial auto subscribes the customer. |
amountInitial | Decimal | The initial amount due. |
amountRecurring | Decimal | The recurring cost of the plan. |
taxable | Integer | 1 or 0. Whether or not taxes apply. |
proRataBilling | Integer | 1 or 0. Whether or not pro-rated billing applies to this plan. |
showInCustomerPortal | Integer | 1 or 0. Whether or not the details will be shown in the customer portal. |
editable | Integer | 1 or 0. Whether or not the recurring plan can be edited. |
cancelable | Integer | 1 or 0. Whether or not the recurring plan can be cancelled. |
automaticRecurring | Integer | 1 or 0. Whether the plan auto subscribes the customer. |
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 started. |
dateRemoved | String | The date the subscription was removed. |
status | String | Active/Inactive. |
amountRecurring | Decimal | The recurring cost of the subscription. |
cyclesBilled | Integer | The number of billing cycles occured. |
cyclesTotal | Integer | The total number of cycles. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
Response Code | Error Code | Message | Description |
---|---|---|---|
0 | - | Invalid Recurring Plan ID | The plan ID provided was invalid, or not entered. |
0 | - | Invalid API Token1 | The API Token is invalid, or not entered. |
0 | - | Missing or Invalid Fields - Account ID | The Account ID is invalid, or not entered. |