{"id":191,"date":"2020-08-10T18:43:45","date_gmt":"2020-08-10T18:43:45","guid":{"rendered":""},"modified":"2021-06-09T15:09:31","modified_gmt":"2021-06-09T15:09:31","slug":"ccbill-api-direct-discount-api","status":"publish","type":"post","link":"https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api","title":{"rendered":"CCBill API: Direct Discount\u00a0API"},"content":{"rendered":"\n

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

This document is issued as an addendum to the CCBill API documentation and discusses subscription discounting functionality. This document is written for developers, technicians, and others with advanced coding skills.<\/p>\n\n\n\n

Overview<\/h2>\n\n\n\n

CCBill has added calls to the CCBill API that allow users to discount subscriptions as an additional tool for consumer retention. The same functionality has been added to the CCBill Admin Portal for those who cannot access the system via the API.<\/p>\n\n\n\n

Exclusions<\/h2>\n\n\n\n

Parameters that are always required (such as clientAccnum, username, password, etc.) are excluded from this chart and are discussed in the main CCBill API<\/a>.<\/p>\n\n\n\n

discountSubscription<\/h2>\n\n\n\n

The discountSubscription call allows you to discount the subscription by a set amount or an entirely new recurring price, depending on the parameters sent with the call.<\/p>\n\n\n\n

Discount by Amount<\/h3>\n\n\n\n

Required (X) and Optional (O) Parameters<\/h4>\n\n\n\n
discountSubscription<\/strong><\/th>clientSubacc<\/th>usingSubacc<\/th>subscriptionId<\/th>returnXML<\/th>dicsountAmount<\/th><\/tr><\/thead>
Main Account<\/td>O<\/td>O<\/td>X<\/td><\/td>X<\/td><\/tr>
Main Account w\/XML<\/td>O<\/td>O<\/td>X<\/td>X<\/td>X<\/td><\/tr>
Subaccount<\/td>O<\/td>O<\/td>X<\/td><\/td>X<\/td><\/tr>
Subaccount w\/XML<\/td>O<\/td>O<\/td>X<\/td>X<\/td>X<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

CSV VERSION EXAMPLE<\/h3>\n\n\n\n

Request String<\/strong><\/p>\n\n\n\n

https:\/\/datalink.ccbill.com\/utils\/subscriptionManagement.cgi?clientAccnum=900112&clientSubacc=0000&username=yourUsername&password=yourPassword&discountAmount=2.00&action=discountSubscription&subscriptionId=1113346401000000080<\/pre>\n\n\n\n
Response<\/strong><\/p>\n\n\n\n
\"results\" \n\"-10\"<\/pre>\n\n\n\n
XML VERSION EXAMPLE<\/h3>\n\n\n\n
Request String<\/strong><\/p>\n\n\n\n
https:\/\/datalink.ccbill.com\/utils\/subscriptionManagement.cgi?clientAccnum=900112&clientSubacc=0000&username=yourUsername&password=yourPassword&discountAmount=2.00&action=discountSubscription&subscriptionId=1113346401000000080&returnXML=1<\/pre>\n\n\n\n
Response<\/strong><\/p>\n\n\n\n
<?xml version=\"1.0\" standalone=\"true\"?>\n<results>-10<\/results><\/pre>\n\n\n\n
Set New Recurring Price<\/h2>\n\n\n\n
discountSubscription<\/strong><\/th>clientSubacc<\/th>usingSubacc<\/th>subscriptionId<\/th>returnXML<\/th>newRecurringPrice<\/th><\/tr><\/thead>
Main Account<\/td>O<\/td>O<\/td>X<\/td><\/td>X<\/td><\/tr>
Main Account w\/XML<\/td>O<\/td>O<\/td>X<\/td>X<\/td>X<\/td><\/tr>
Subaccount<\/td>O<\/td>O<\/td>X<\/td><\/td>X<\/td><\/tr>
Subaccount w\/XML<\/td>O<\/td>O<\/td>X<\/td>X<\/td>X<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
CSV VERSION EXAMPLE<\/h3>\n\n\n\n
Request String<\/strong><\/p>\n\n\n\n
https:\/\/datalink.ccbill.com\/utils\/subscriptionManagement.cgi?clientAccnum=900112&clientSubacc=0000&username=yourUsername&password=yourPassword&newRecurringPrice=18.95&action=discountSubscription&subscriptionId=1113346401000000080<\/pre>\n\n\n\n
Response<\/strong><\/p>\n\n\n\n
\"results\" \n\"-10\"<\/pre>\n\n\n\n
XML VERSION EXAMPLE<\/h3>\n\n\n\n
Request String<\/strong><\/p>\n\n\n\n
https:\/\/datalink.ccbill.com\/utils\/subscriptionManagement.cgi?clientAccnum=900112&clientSubacc=0000&username=yourUsername&password=yourPassword&newRecurringPrice=18.95&action=discountSubscription&subscriptionId=1113346401000000080&returnXML=1<\/pre>\n\n\n\n
Response<\/strong><\/p>\n\n\n\n
<?xml version=\"1.0\" standalone=\"true\"?>\n<results>-10<\/results><\/pre>\n\n\n\n
Information Returned<\/h2>\n\n\n\n
Error Codes<\/h3>\n\n\n\n
Code<\/strong><\/th>Description<\/strong><\/th>More Information<\/strong><\/th><\/tr><\/thead>
-2<\/td>The subscription ID provided was invalid or the subscription type is not supported by the requested action.<\/td>A new recurring price cannot be passed in for a non-recurring subscription.<\/td><\/tr>
-18<\/td>Recurring price is less than the minimum allowable.<\/td>A discount cannot be added to any subscription that will result in a price lower than 5.00 units (currency notwithstanding).<\/td><\/tr>
-19<\/td>Discount amount is less than the minimum allowable.<\/td>The discount amount cannot be less than 0.01 units (currency notwithstanding).<\/td><\/tr>
-20<\/td>The New recurring price is greater than the subscription recurring price.<\/td>The system cannot process a discount that results in a higher price than the current subscription.<\/td><\/tr>
-21<\/td>Cannot replace cancel discount with a smaller amount.<\/td>The system cannot process a discount with this function that DOES NOT result in a lower subscription price than an already existing cancel discount.<\/td><\/tr>
-22<\/td>This subscription is not eliigible for a discount.<\/td>Discounts can only be applied to an Active trial or an Active recurring subscription.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Version History<\/h2>\n\n\n\n
Version<\/th>Date<\/th>Change Log<\/th><\/tr><\/thead>
1<\/td>1.16.2014<\/td>New CCBill API Call Documentation.<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"
Introduction This document is issued as an addendum to the CCBill API documentation and discusses...<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"kk_blocks_editor_width":"","_kiokenblocks_attr":"","_kiokenblocks_dimensions":"","footnotes":""},"categories":[29],"tags":[],"class_list":["post-191","post","type-post","status-publish","format-standard","hentry","category-api-documentation"],"acf":[],"yoast_head":"\nCCBill Merchant Knowledge Base | CCBill API: Direct Discount API<\/title>\n<meta name=\"description\" content=\"CCBill has added calls to SMS that allow users to discount subscriptions as an additional tool for consumer retention.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"CCBill Merchant Knowledge Base | CCBill API: Direct Discount API\" \/>\n<meta property=\"og:description\" content=\"CCBill has added calls to SMS that allow users to discount subscriptions as an additional tool for consumer retention.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api\" \/>\n<meta property=\"og:site_name\" content=\"CCBill Doc\" \/>\n<meta property=\"article:published_time\" content=\"2020-08-10T18:43:45+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2021-06-09T15:09:31+00:00\" \/>\n<meta name=\"author\" content=\"Goran Jevtic\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Goran Jevtic\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api\",\"url\":\"https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api\",\"name\":\"CCBill Merchant Knowledge Base | CCBill API: Direct Discount API\",\"isPartOf\":{\"@id\":\"https:\/\/ccbill.com\/doc\/#website\"},\"datePublished\":\"2020-08-10T18:43:45+00:00\",\"dateModified\":\"2021-06-09T15:09:31+00:00\",\"author\":{\"@id\":\"https:\/\/ccbill.com\/doc\/#\/schema\/person\/07053eea9e71524817d8c51f00e49547\"},\"description\":\"CCBill has added calls to SMS that allow users to discount subscriptions as an additional tool for consumer retention.\",\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api\"]}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/ccbill.com\/doc\/#website\",\"url\":\"https:\/\/ccbill.com\/doc\/\",\"name\":\"CCBill Doc\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/ccbill.com\/doc\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/ccbill.com\/doc\/#\/schema\/person\/07053eea9e71524817d8c51f00e49547\",\"name\":\"Goran Jevtic\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/ccbill.com\/doc\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/2f1f69525606d377dbc5663dc0499431?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/2f1f69525606d377dbc5663dc0499431?s=96&d=mm&r=g\",\"caption\":\"Goran Jevtic\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"CCBill Merchant Knowledge Base | CCBill API: Direct Discount API","description":"CCBill has added calls to SMS that allow users to discount subscriptions as an additional tool for consumer retention.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api","og_locale":"en_US","og_type":"article","og_title":"CCBill Merchant Knowledge Base | CCBill API: Direct Discount API","og_description":"CCBill has added calls to SMS that allow users to discount subscriptions as an additional tool for consumer retention.","og_url":"https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api","og_site_name":"CCBill Doc","article_published_time":"2020-08-10T18:43:45+00:00","article_modified_time":"2021-06-09T15:09:31+00:00","author":"Goran Jevtic","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Goran Jevtic","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api","url":"https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api","name":"CCBill Merchant Knowledge Base | CCBill API: Direct Discount API","isPartOf":{"@id":"https:\/\/ccbill.com\/doc\/#website"},"datePublished":"2020-08-10T18:43:45+00:00","dateModified":"2021-06-09T15:09:31+00:00","author":{"@id":"https:\/\/ccbill.com\/doc\/#\/schema\/person\/07053eea9e71524817d8c51f00e49547"},"description":"CCBill has added calls to SMS that allow users to discount subscriptions as an additional tool for consumer retention.","inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/ccbill.com\/doc\/ccbill-api-direct-discount-api"]}]},{"@type":"WebSite","@id":"https:\/\/ccbill.com\/doc\/#website","url":"https:\/\/ccbill.com\/doc\/","name":"CCBill Doc","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/ccbill.com\/doc\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/ccbill.com\/doc\/#\/schema\/person\/07053eea9e71524817d8c51f00e49547","name":"Goran Jevtic","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/ccbill.com\/doc\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/2f1f69525606d377dbc5663dc0499431?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/2f1f69525606d377dbc5663dc0499431?s=96&d=mm&r=g","caption":"Goran Jevtic"}}]}},"_links":{"self":[{"href":"https:\/\/ccbill.com\/doc\/wp-json\/wp\/v2\/posts\/191"}],"collection":[{"href":"https:\/\/ccbill.com\/doc\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ccbill.com\/doc\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ccbill.com\/doc\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/ccbill.com\/doc\/wp-json\/wp\/v2\/comments?post=191"}],"version-history":[{"count":2,"href":"https:\/\/ccbill.com\/doc\/wp-json\/wp\/v2\/posts\/191\/revisions"}],"predecessor-version":[{"id":3876,"href":"https:\/\/ccbill.com\/doc\/wp-json\/wp\/v2\/posts\/191\/revisions\/3876"}],"wp:attachment":[{"href":"https:\/\/ccbill.com\/doc\/wp-json\/wp\/v2\/media?parent=191"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ccbill.com\/doc\/wp-json\/wp\/v2\/categories?post=191"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ccbill.com\/doc\/wp-json\/wp\/v2\/tags?post=191"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}