CCBill API: Cancel Subscription
Introduction
This document is issued as an addendum to the CCBill API documentation and discusses subscription cancellation functionality. This document is written for developers, technicians, and others with advanced coding skills.Overview
Subscription cancellation allows merchants to cancel a consumer subscription. This is performed by sending a query string to the following CGI script with variable values appended:https://datalink.ccbill.com/utils/subscriptionManagement.cgi
Once the variables have been passed to the script, the subscription will be canceled.
Required (X) and Optional (O) Parameters
cancelSubscription | clientSubacc |
usingSubacc |
subscriptionId |
returnXML |
Main Account | O |
X |
||
Main Account w/XML | O |
X |
X |
|
Sub Account | X |
X |
||
Sub Account w/XML | X |
X |
X |
Information Returned
A success or failure code will be returned. For a full list of error codes and explanations, please consult the CCBill API Guide.CSV Version Example
Request string
https://datalink.ccbill.com/utils/subscriptionManagement.cgi?clientSubacc=&usingSubacc=0005&subscriptionId=1071776966&username=ccbill12&password=test123&action=cancelSubscription&clientAccnum=923590
Return
Fields: "results" Values: "1"
XML Version Example
!!!Request string https://datalink.ccbill.com/utils/subscriptionManagement.cgi?clientSubacc=&usingSubacc=0005&subscriptionId=1071776966&username=ccbill12&password=test123&returnXML=1&action=cancelSubscription&clientAccnum=923590
Return
<?xml version='1.0' standalone='yes'?> <results>1</results>
Edit History
Version | Date |
---|---|
1 | April, 2008 |