Skip to main content (Press Enter)
Helcim Logo
Click here if you return to contents

Adding or Removing Subscription Add-ons

This API call lets you add or remove a subscription add-on.

Request Fields

Field Name Type Required Description
action String Yes subscriptionItemEdit
subscriptionId Integer Yes The Subscription Id
addonCode String Yes Code of the Addon you want to update
remove Integer Yes 0: do not remove, 1: remove
dateStarted String Yes date when you want to start the add-on
dateRemoved String Yes date when you want to remove the add-on, empty string if you dont have Removal Date
quantity Decimal Yes The quantity
amount Decimal Yes The amount

Response Fields

Field Name Type Description
message - XML structure
response Integer 1 or 0. Whether the subscription was added/edited or not.
responseMessage String Confirmation of action taken.
subscription - XML structure
id Integer The subscription ID>
items - XML structure
item - XML structure
code String The Addon Code
dateStarted String Date Addon is started
dateRemoved String Date Addon will be removed
quantity Decimal Addon quantity
amount Decimal Addon amount
total Decimal Addon total

Errors

Response Code Error Code Message Description
0 - Invalid Subscription Id The subscription ID provided is invalid.
0 - Invalid Addon Code Missing or Empty addonCode
0 - Missing remove missing remove request
0 - Invalid Date Started Missing or empty dateStarted
0 - Invalid Date Removed Missing dateRemoved
0 - Invalid Quantity Missing quantity
0 - Invalid Amount Missing amount
0 - Subscription is not Active Subscription is not active
0 - Invalid Addon Addon code is invalid
0 - Invalid Subscription and Addon Addon code is not applicable to subscription
0 - Invalid Start Date Invalid format of dateStarted
0 - Invalid Removed Date Invalid format of dateRemoved
0 - Date Removed Cannot Be Smaller Than Date Started on Active Add-Ons dateRemoved comes before dateStarted
0 - Failed Removing Subscription Item System failed to remove subscription item
0 - Failed Updating Subscription Item System failed to add/update subscription item

Related Articles

View a Recurring Plan
Queue a Recurring Plan for Processing
Add or Edit a Subscription
View a Subscription
Subscription List

Was this article helpful?

Feedback submitted - Thank you!

If you need immediate assistance please contact our Merchant Experience Specialists here

Click here if you return to the content