{"id":1053,"date":"2020-08-10T18:44:48","date_gmt":"2020-08-10T18:44:48","guid":{"rendered":""},"modified":"2025-07-09T09:42:14","modified_gmt":"2025-07-09T09:42:14","slug":"ccbill-api-guide","status":"publish","type":"post","link":"https:\/\/ccbill.com\/doc\/ccbill-api-guide","title":{"rendered":"CCBill API\u00a0Guide"},"content":{"rendered":"\n

Introduction<\/h2>\n\n\n\n

This document is provided as a technical resource to CCBill merchants.<\/p>\n\n\n\n

The information contained in this document concerns establishing and using the merchant-side consumer service Application Program Interface (API). The Subscription Management script replaces the Custom Cancel script and provides additional new features. The information contained in this document outlines the Subscription Management functionality and its interaction with the CCBill User Management System. Proper setup of the Data Link Extract System is required before the CCBill API can be utilized.<\/p>\n\n\n\n

CCBill API<\/h2>\n\n\n\n

The subscriptionManagement.cgi<\/strong> script replaces the customCancel.cgi script in the Data Link Extract System. The CCBill API has additional features that were not included in the customCancel.cgi.<\/p>\n\n\n\n

Before the subscriptionManagement.cgi<\/strong> script can be used your system must be set up to access the CCBill Data Link Extract System.<\/p>\n\n\n\n

The CCBill Data Link Extract System allows CCBill merchants to access transaction data from the CCBill database with a CGI script. Consult the Data Link Extract User Guide<\/a> for further information about Data Link Extract.<\/strong><\/p>\n\n\n\n

Required Parameters for Authentication<\/h2>\n\n\n\n

clientAccnum<\/h3>\n\n\n\n

This parameter specifies the main CCBill merchant account number of the merchant that is requesting the data. The value must be a six digit number.<\/p>\n\n\n\n

username<\/h3>\n\n\n\n

This is the username that was setup for authentication on the Data Link Extract system.<\/p>\n\n\n\n

password<\/h3>\n\n\n\n

This is the password that was setup for authentication on the Data Link Extract system.<\/p>\n\n\n\n

action<\/h3>\n\n\n\n

This is the function to be performed within the CCBill API. See Supported Actions for a complete list of available options.<\/p>\n\n\n\n

The table lists the parameters that are always required regardless if the action is to be performed on the main account or on a subaccount:<\/p>\n\n\n\n

clientAccnum<\/td>username<\/td>password<\/td>action<\/td><\/tr>
Main Account<\/td> X<\/td>X<\/td>X<\/td><\/tr>
Sub Account<\/td> X<\/td>X<\/td>X<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Main Account Number<\/strong> - All CCBill merchants receive an account number for tracking purposes. The standard format is 9xxxxx-xxxx<\/em>, where 9xxxxx is the main account. The main account is a 6-digit number. For example: \"900000\"<\/strong>.<\/p>\n\n\n\n

Sub Account Number<\/strong> - After a merchant signs up for website billing, they may open one or more subaccounts. The subaccount is a 4-digit number. The standard format is: xxxx<\/em>. For example: \"0002<\/strong>\". The subaccount is part of the main account.<\/p>\n\n\n\n

Optional Parameters<\/h2>\n\n\n\n

clientSubacc<\/h3>\n\n\n\n

This is the specific subaccount number the subscription is related to; it must be four digits long. If this parameter is provided, you will be authenticated on a specific subaccount and not on the main account. Any requested action must pertain to this subaccount, otherwise the operation will fail. If you wish to be authenticated on the main account (i.e. your DataLink user was created on the account level) you should omit this parameter.<\/p>\n\n\n\n

usingSubacc<\/h3>\n\n\n\n

Use this parameter if you wish to be authenticated on the main account but not on a specific subaccount. This parameter specifies a subaccount on which a requested operation will be performed.<\/p>\n\n\n

\n

Note<\/strong>: If clientSubacc<\/code><\/strong> is passed in along with usingSubacc<\/code><\/strong>, they must have the same value for a successful authentication. Different values would cause you to authenticate on a specific subaccount and operate on another.<\/p>\n<\/div>\n<\/div>\n\n\n\n

returnXML<\/h3>\n\n\n\n

If this parameter is passed in, you will receive the information in XML format; otherwise the information is returned in CSV (comma separated values) format.<\/p>\n\n\n\n

Supported Actions and Required Parameters<\/h2>\n\n\n\n

viewSubscriptionStatus<\/h3>\n\n\n\n

Reports the status of a customer subscription.<\/p>\n\n\n\n

Required (X) and Optional (O) Parameters<\/h4>\n\n\n\n
viewSubscriptionStatus<\/td>clientSubacc<\/td>usingSubacc<\/td>subscriptionId<\/td>returnXML<\/td><\/tr>
Main Account<\/td> <\/td> O<\/td>X<\/td> <\/td><\/tr>
Main Account w\/XML<\/td> <\/td> O<\/td>X<\/td>X<\/td><\/tr>
Sub Account<\/td> X<\/td> <\/td>X<\/td> <\/td><\/tr>
Sub Account w\/XML<\/td> X<\/td> <\/td>X<\/td>X<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Information Returned<\/h4>\n\n\n\n