NewSaleSuccess

Some fields, such as avsResponse and cvv2Response, will not be sent if the associated features have not been configured by Merchant Support.

This event has more than one version. Click the tab for the version you want to view.


Version 1

Supported Formats: URL Encoded

Variable Name Description Data Type
(Max Length)		 Example Value
subscriptionId Subscription ID Number. bigint(20) unsigned 1000000000
transactionId Transaction identification number. string 0912191101000000159
clientAccnum CCBill Merchant main account number. mediumint(6)
unsigned
 900100
clientSubacc CCBill Merchant Sub Account Number. smallint(4)
unsigned
zerofill		 0000
timestamp Time the event occurred. date 2012‐08‐05 15:18:17
firstName The first name of the consumer. string John
lastName The last name of the consumer string Doe
address1 Consumer address. varchar(30) 123 Main Street
city Consumer city. varchar(30) Anytown
state Consumer state. varchar(20) AZ
country Consumer country. varchar(30) US
postalCode Consumer ZIP Code. varchar(10) 50115
email Consumer Email address. varchar(40) user@randomurl.com
phoneNumber Consumer phone number; appears as entered by consumer. varchar(20) (515) 555-1212
ipAddress Consumer IP Address varchar(31) 192.168.27.4
reservationId Consumer’s subscription Reservation ID number. bigint(20)
unsigned		 0109072310330002423
username Consumer username. varchar(16) username1
password Consumer password. varchar(30) mYPaSSw0rD
formName Three (or more) character code for the CCBill form. char(255) 13cc
productDesc Description of the product purchased. varchar(50) Sample product description text.
priceDescription Initial Price Description. string 10.00(USD) for 10 days (trial) then 10.00(USD) recurring every 30 days
recurringPriceDescription The price to be charged on subsequent rebill dates. string 22.22(USD) recurring every 30 days
billedInitialPrice The initial price of the subscription. string 4.95
billedRecurringPrice Recurring price of the subscription. string 19.95
billedCurrencyCode Three‐digit currency in which the consumer was billed. int(3) 978 (see Appendix A for a list of Currency Codes.)
subscriptionInitialPrice The initial price of the subscription. decimal(9,2) 4.99
subscriptionRecurringPrice The recurring price of the subscription. decimal(7,2) 4.99
subscriptionCurrencyCode Three‐digit currency in which the consumer will be rebilled. int(3) 978 (see Appendix A for a list of Currency Codes.)
accountingInitialPrice The initial price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingRecurringPrice The recurring price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingCurrencyCode Three‐digit currency in which the Merchant will be paid. int(3) 840 (see Appendix A for a list of Currency Codes.)
initialPeriod The initial period of the subscription (in days). smallint(4)
unsigned		 7
recurringPeriod The recurring period of the subscription (in days). smallint(4)
unsigned		 30
rebills The total number of rebills for the subscription. tinyint(2)
unsigned		 12
nextRenewalDate Next billing date for recurring subscriptions string 2012-09-19
subscriptionTypeId Subscription Type ID number identifying the price point used in the transaction. int(10) 0000060748
dynamicPricingValidationDigest Hash digest of a Dynamic Pricing response. If not using Dynamic Pricing, this value will return as a blank string. string(32) s4f5198jgd21a4pk1p2s7sd23lm58937
paymentType The payment type used for the transaction. string Possible Values: CREDIT, CHECK, TELEPHONE, or DPEU
cardType Credit Card type used for a CREDIT transaction. Only displays if payment type = CREDIT. string VISA, MASTERCARD, DISCOVER, JCB, AMEX, OTHER
prePaid Indicates whether a prepaid card was used for payment. string 0, 1
avsResponse The Response Code sent from the Address Verification system. Only displays if payment type = CREDIT. string Y
cvv2Response The Response Code sent from the CVV2 Verification System. Only displays if payment type = CREDIT. string M
affiliateSystem Indicates the Affiliate System used. string LTS
WMS
Miscellaneous
referringUrl URL from which the transaction was referred. string http://www.referringurl.biz
lifeTimeSubscription Indicates if the transaction is a Lifetime Subscription. Is not posted if not positive. int 1
lifeTimePrice Indicates the price paid for a lifetime subscription. string 40.25
Pass-through Key/Values Pass-through value pairs are passed with this post, if they exist. string Varies. Multiple pass-through sets can be sent.

Version 2

Supported Formats: URL Encoded

This version was released on 2013-10-30 and the paymentAccount field was added.

Variable Name Description Data Type
(Max Length)		 Example Value
subscriptionId Subscription ID Number. bigint(20) unsigned 1000000000
transactionId Transaction identification number. string 0912191101000000159
clientAccnum CCBill Merchant main account number. mediumint(6)
unsigned
 900100
clientSubacc CCBill Merchant Sub Account Number. smallint(4)
unsigned
zerofill		 0000
timestamp Time the event occurred. date 2012‐08‐05 15:18:17
firstName The first name of the consumer. string John
lastName The last name of the consumer string Doe
address1 Consumer address. varchar(30) 123 Main Street
city Consumer city. varchar(30) Anytown
state Consumer state. varchar(20) AZ
country Consumer country. varchar(30) US
postalCode Consumer ZIP Code. varchar(10) 50115
email Consumer Email address. varchar(40) user@randomurl.com
phoneNumber Consumer phone number; appears as entered by consumer. varchar(20) (515) 555-1212
ipAddress Consumer IP Address varchar(31) 192.168.27.4
reservationId Consumer’s subscription Reservation ID number. bigint(20)
unsigned		 0109072310330002423
username Consumer username. varchar(16) username1
password Consumer password. varchar(30) mYPaSSw0rD
formName Three (or more) character code for the CCBill form. char(255) 13cc
productDesc Description of the product purchased. varchar(50) Sample product description text.
priceDescription Initial Price Description. string 10.00(USD) for 10 days (trial) then 10.00(USD) recurring every 30 days
recurringPriceDescription The price to be charged on subsequent rebill dates. string 22.22(USD) recurring every 30 days
billedInitialPrice The initial price of the subscription. string 4.95
billedRecurringPrice Recurring price of the subscription. string 19.95
billedCurrencyCode Three‐digit currency in which the consumer was billed. int(3) 978 (see Appendix A for a list of Currency Codes.)
subscriptionInitialPrice The initial price of the subscription. decimal(9,2) 4.99
subscriptionRecurringPrice The recurring price of the subscription. decimal(7,2) 4.99
subscriptionCurrencyCode Three‐digit currency in which the consumer will be rebilled. int(3) 978 (see Appendix A for a list of Currency Codes.)
accountingInitialPrice The initial price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingRecurringPrice The recurring price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingCurrencyCode Three‐digit currency in which the Merchant will be paid. int(3) 840 (see Appendix A for a list of Currency Codes.)
initialPeriod The initial period of the subscription (in days). smallint(4)
unsigned		 7
recurringPeriod The recurring period of the subscription (in days). smallint(4)
unsigned		 30
rebills The total number of rebills for the subscription. tinyint(2)
unsigned		 12
nextRenewalDate Next billing date for recurring subscriptions string 2012-09-19
subscriptionTypeId Subscription Type ID number identifying the price point used in the transaction. int(10) 0000060748
dynamicPricingValidationDigest Hash digest of a Dynamic Pricing response. If not using Dynamic Pricing, this value will return as a blank string. string(32) s4f5198jgd21a4pk1p2s7sd23lm58937
paymentType The payment type used for the transaction. string Possible Values: CREDIT, CHECK, TELEPHONE, or DPEU
cardType Credit Card type used for a CREDIT transaction. Only displays if payment type = CREDIT. string VISA, MASTERCARD, DISCOVER, JCB, AMEX, OTHER
prePaid Indicates whether a prepaid card was used for payment. string 0, 1
avsResponse The Response Code sent from the Address Verification system. Only displays if payment type = CREDIT. string Y
cvv2Response The Response Code sent from the CVV2 Verification System. Only displays if payment type = CREDIT. string M
affiliateSystem Indicates the Affiliate System used. string LTS
WMS
Miscellaneous
referringUrl URL from which the transaction was referred. string http://www.referringurl.biz
lifeTimeSubscription Indicates if the transaction is a Lifetime Subscription. Is not posted if not positive. int 1
lifeTimePrice Indicates the price paid for a lifetime subscription. string 40.25
Pass-through Key/Values Pass-through value pairs are passed with this post, if they exist. string Varies. Multiple pass-through sets can be sent.
paymentAccount Field must be configured by CCBill for data to be sent. alpha-numeric hash 57bc7327b5d721d7d20b240c0357e6ed

Version 3

Supported Formats: URL Encoded

This version released on 2014-04-24 includes a new variable called flexId.

Variable Name Description Data Type
(Max Length)		 Example Value
subscriptionId Subscription ID Number. bigint(20) unsigned 1000000000
transactionId Transaction identification number. string 0912191101000000159
clientAccnum CCBill Merchant main account number. mediumint(6)
unsigned
 900100
clientSubacc CCBill Merchant Sub Account Number. smallint(4)
unsigned
zerofill		 0000
timestamp Time the event occurred. date 2012‐08‐05 15:18:17
firstName The first name of the consumer. string John
lastName The last name of the consumer string Doe
address1 Consumer address. varchar(30) 123 Main Street
city Consumer city. varchar(30) Anytown
state Consumer state. varchar(20) AZ
country Consumer country. varchar(30) US
postalCode Consumer ZIP Code. varchar(10) 50115
email Consumer Email address. varchar(40) user@randomurl.com
phoneNumber Consumer phone number; appears as entered by consumer. varchar(20) (515) 555-1212
ipAddress Consumer IP Address varchar(31) 192.168.27.4
reservationId Consumer’s subscription Reservation ID number. bigint(20)
unsigned		 0109072310330002423
username Consumer username. varchar(16) username1
password Consumer password. varchar(30) mYPaSSw0rD
formName Three (or more) character code for the CCBill form. char(255) 13cc
flexId Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used. UUID(36) cb617dcc-8467-49ab-b3a7-735ce1d60ad9
productDesc Description of the product purchased. varchar(50) Sample product description text.
priceDescription Initial Price Description. string 10.00(USD) for 10 days (trial) then 10.00(USD) recurring every 30 days
recurringPriceDescription The price to be charged on subsequent rebill dates. string 22.22(USD) recurring every 30 days
billedInitialPrice The initial price of the subscription. string 4.95
billedRecurringPrice Recurring price of the subscription. string 19.95
billedCurrencyCode Three‐digit currency in which the consumer was billed. int(3) 978 (see Appendix A for a list of Currency Codes.)
subscriptionInitialPrice The initial price of the subscription. decimal(9,2) 4.99
subscriptionRecurringPrice The recurring price of the subscription. decimal(7,2) 4.99
subscriptionCurrencyCode Three‐digit currency in which the consumer will be rebilled. int(3) 978 (see Appendix A for a list of Currency Codes.)
accountingInitialPrice The initial price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingRecurringPrice The recurring price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingCurrencyCode Three‐digit currency in which the Merchant will be paid. int(3) 840 (see Appendix A for a list of Currency Codes.)
initialPeriod The initial period of the subscription (in days). smallint(4)
unsigned		 7
recurringPeriod The recurring period of the subscription (in days). smallint(4)
unsigned		 30
rebills The total number of rebills for the subscription. tinyint(2)
unsigned		 12
nextRenewalDate Next billing date for recurring subscriptions string 2012-09-19
subscriptionTypeId Subscription Type ID number identifying the price point used in the transaction. int(10) 0000060748
dynamicPricingValidationDigest Hash digest of a Dynamic Pricing response. If not using Dynamic Pricing, this value will return as a blank string. string(32) s4f5198jgd21a4pk1p2s7sd23lm58937
paymentType The payment type used for the transaction. string Possible Values: CREDIT, CHECK, TELEPHONE, or DPEU
cardType Credit Card type used for a CREDIT transaction. Only displays if payment type = CREDIT. string VISA, MASTERCARD, DISCOVER, JCB, AMEX, OTHER
prePaid Indicates whether a prepaid card was used for payment. string 0, 1
avsResponse The Response Code sent from the Address Verification system. Only displays if payment type = CREDIT. string Y
cvv2Response The Response Code sent from the CVV2 Verification System. Only displays if payment type = CREDIT. string M
affiliateSystem Indicates the Affiliate System used. string LTS
WMS
Miscellaneous
referringUrl URL from which the transaction was referred. string http://www.referringurl.biz
lifeTimeSubscription Indicates if the transaction is a Lifetime Subscription. Is not posted if not positive. int 1
lifeTimePrice Indicates the price paid for a lifetime subscription. string 40.25
Pass-through Key/Values Pass-through value pairs are passed with this post, if they exist. string Varies. Multiple pass-through sets can be sent.
paymentAccount Field must be configured by CCBill for data to be sent. alpha-numeric hash 57bc7327b5d721d7d20b240c0357e6ed

Version 4

Supported Formats: URL Encoded

This version released on 2017-04-13 includes two new variables called expDate and last4.

Variable Name Description Data Type
(Max Length)		 Example Value
subscriptionId Subscription ID Number. bigint(20) unsigned 1000000000
transactionId Transaction identification number. string 0912191101000000159
clientAccnum CCBill Merchant main account number. mediumint(6)
unsigned
 900100
clientSubacc CCBill Merchant Sub Account Number. smallint(4)
unsigned
zerofill		 0000
timestamp Time the event occurred. date 2012‐08‐05 15:18:17
firstName The first name of the consumer. string John
lastName The last name of the consumer string Doe
address1 Consumer address. varchar(30) 123 Main Street
city Consumer city. varchar(30) Anytown
state Consumer state. varchar(20) AZ
country Consumer country. varchar(30) US
postalCode Consumer ZIP Code. varchar(10) 50115
email Consumer Email address. varchar(40) user@randomurl.com
phoneNumber Consumer phone number; appears as entered by consumer. varchar(20) (515) 555-1212
ipAddress Consumer IP Address varchar(31) 192.168.27.4
reservationId Consumer’s subscription Reservation ID number. bigint(20)
unsigned		 0109072310330002423
username Consumer username. varchar(16) username1
password Consumer password. varchar(30) mYPaSSw0rD
formName Three (or more) character code for the CCBill form. char(255) 13cc
flexId Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used. UUID(36) cb617dcc-8467-49ab-b3a7-735ce1d60ad9
productDesc Description of the product purchased. varchar(50) Sample product description text.
priceDescription Initial Price Description. string 10.00(USD) for 10 days (trial) then 10.00(USD) recurring every 30 days
recurringPriceDescription The price to be charged on subsequent rebill dates. string 22.22(USD) recurring every 30 days
billedInitialPrice The initial price of the subscription. string 4.95
billedRecurringPrice Recurring price of the subscription. string 19.95
billedCurrencyCode Three‐digit currency in which the consumer was billed. int(3) 978 (see Appendix A for a list of Currency Codes.)
subscriptionInitialPrice The initial price of the subscription. decimal(9,2) 4.99
subscriptionRecurringPrice The recurring price of the subscription. decimal(7,2) 4.99
subscriptionCurrencyCode Three‐digit currency in which the consumer will be rebilled. int(3) 978 (see Appendix A for a list of Currency Codes.)
accountingInitialPrice The initial price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingRecurringPrice The recurring price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingCurrencyCode Three‐digit currency in which the Merchant will be paid. int(3) 840 (see Appendix A for a list of Currency Codes.)
initialPeriod The initial period of the subscription (in days). smallint(4)
unsigned		 7
recurringPeriod The recurring period of the subscription (in days). smallint(4)
unsigned		 30
rebills The total number of rebills for the subscription. tinyint(2)
unsigned		 12
nextRenewalDate Next billing date for recurring subscriptions string 2012-09-19
subscriptionTypeId Subscription Type ID number identifying the price point used in the transaction. int(10) 0000060748
dynamicPricingValidationDigest Hash digest of a Dynamic Pricing response. If not using Dynamic Pricing, this value will return as a blank string. string(32) s4f5198jgd21a4pk1p2s7sd23lm58937
paymentType The payment type used for the transaction. string Possible Values: CREDIT, CHECK, TELEPHONE, or DPEU
cardType Credit Card type used for a CREDIT transaction. Only displays if payment type = CREDIT. string VISA, MASTERCARD, DISCOVER, JCB, AMEX, OTHER
prePaid Indicates whether a prepaid card was used for payment. string 0, 1
last4 Last 4 digits of the Credit Card number or Banking Account number. smallint(4) unsigned zerofill 5100
expDate Expiration Date for Credit Card or Payment Card provided. smallint(4) unsigned zerofill 0217
(MMYY)
avsResponse The Response Code sent from the Address Verification system. Only displays if payment type = CREDIT. string Y
cvv2Response The Response Code sent from the CVV2 Verification System. Only displays if payment type = CREDIT. string M
affiliateSystem Indicates the Affiliate System used. string LTS
WMS
Miscellaneous
referringUrl URL from which the transaction was referred. string http://www.referringurl.biz
lifeTimeSubscription Indicates if the transaction is a Lifetime Subscription. Is not posted if not positive. int 1
lifeTimePrice Indicates the price paid for a lifetime subscription. string 40.25
Pass-through Key/Values Pass-through value pairs are passed with this post, if they exist. string Varies. Multiple pass-through sets can be sent.
paymentAccount Field must be configured by CCBill for data to be sent. alpha-numeric hash 57bc7327b5d721d7d20b240c0357e6ed

Version 5

Supported Formats: URL Encoded

This version released on 2017-05-11 includes a new variable called bin.

Variable Name Description Data Type
(Max Length)		 Example Value
subscriptionId Subscription ID Number. bigint(20) unsigned 1000000000
transactionId Transaction identification number. string 0912191101000000159
clientAccnum CCBill Merchant main account number. mediumint(6)
unsigned
 900100
clientSubacc CCBill Merchant Sub Account Number. smallint(4)
unsigned
zerofill		 0000
timestamp Time the event occurred. date 2012‐08‐05 15:18:17
firstName The first name of the consumer. string John
lastName The last name of the consumer string Doe
address1 Consumer address. varchar(30) 123 Main Street
city Consumer city. varchar(30) Anytown
state Consumer state. varchar(20) AZ
country Consumer country. varchar(30) US
postalCode Consumer ZIP Code. varchar(10) 50115
email Consumer Email address. varchar(40) user@randomurl.com
phoneNumber Consumer phone number; appears as entered by consumer. varchar(20) (515) 555-1212
ipAddress Consumer IP Address varchar(31) 192.168.27.4
reservationId Consumer’s subscription Reservation ID number. bigint(20)
unsigned		 0109072310330002423
username Consumer username. varchar(16) username1
password Consumer password. varchar(30) mYPaSSw0rD
formName Three (or more) character code for the CCBill form. char(255) 13cc
flexId Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used. UUID(36) cb617dcc-8467-49ab-b3a7-735ce1d60ad9
productDesc Description of the product purchased. varchar(50) Sample product description text.
priceDescription Initial Price Description. string 10.00(USD) for 10 days (trial) then 10.00(USD) recurring every 30 days
recurringPriceDescription The price to be charged on subsequent rebill dates. string 22.22(USD) recurring every 30 days
billedInitialPrice The initial price of the subscription. string 4.95
billedRecurringPrice Recurring price of the subscription. string 19.95
billedCurrencyCode Three‐digit currency in which the consumer was billed. int(3) 978 (see Appendix A for a list of Currency Codes.)
subscriptionInitialPrice The initial price of the subscription. decimal(9,2) 4.99
subscriptionRecurringPrice The recurring price of the subscription. decimal(7,2) 4.99
subscriptionCurrencyCode Three‐digit currency in which the consumer will be rebilled. int(3) 978 (see Appendix A for a list of Currency Codes.)
accountingInitialPrice The initial price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingRecurringPrice The recurring price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingCurrencyCode Three‐digit currency in which the Merchant will be paid. int(3) 840 (see Appendix A for a list of Currency Codes.)
initialPeriod The initial period of the subscription (in days). smallint(4)
unsigned		 7
recurringPeriod The recurring period of the subscription (in days). smallint(4)
unsigned		 30
rebills The total number of rebills for the subscription. tinyint(2)
unsigned		 12
nextRenewalDate Next billing date for recurring subscriptions string 2012-09-19
subscriptionTypeId Subscription Type ID number identifying the price point used in the transaction. int(10) 0000060748
dynamicPricingValidationDigest Hash digest of a Dynamic Pricing response. If not using Dynamic Pricing, this value will return as a blank string. string(32) s4f5198jgd21a4pk1p2s7sd23lm58937
paymentType The payment type used for the transaction. string Possible Values: CREDIT, CHECK, TELEPHONE, or DPEU
cardType Credit Card type used for a CREDIT transaction. Only displays if payment type = CREDIT. string VISA, MASTERCARD, DISCOVER, JCB, AMEX, OTHER
bin BIN of the Credit Card used mediumint(6)
unsigned		 510510
prePaid Indicates whether a prepaid card was used for payment. string 0, 1
last4 Last 4 digits of the Credit Card number or Banking Account number. smallint(4) unsigned zerofill 5100
expDate Expiration Date for Credit Card or Payment Card provided. smallint(4) unsigned zerofill 0217
(MMYY)
avsResponse The Response Code sent from the Address Verification system. Only displays if payment type = CREDIT. string Y
cvv2Response The Response Code sent from the CVV2 Verification System. Only displays if payment type = CREDIT. string M
affiliateSystem Indicates the Affiliate System used. string LTS
WMS
Miscellaneous
referringUrl URL from which the transaction was referred. string http://www.referringurl.biz
lifeTimeSubscription Indicates if the transaction is a Lifetime Subscription. Is not posted if not positive. int 1
lifeTimePrice Indicates the price paid for a lifetime subscription. string 40.25
Pass-through Key/Values Pass-through value pairs are passed with this post, if they exist. string Varies. Multiple pass-through sets can be sent.
paymentAccount Field must be configured by CCBill for data to be sent. alpha-numeric hash 57bc7327b5d721d7d20b240c0357e6ed

Version 6

Supported Formats: URL Encoded, JSON

This version was released on 2020-02-11 and it includes one new parameter called threeDSecure.

Variable Name Description Data Type
(Max Length)		 Example Value
subscriptionId Subscription ID Number. bigint(20) unsigned 1000000000
transactionId Transaction identification number. string 0912191101000000159
clientAccnum CCBill Merchant main account number. mediumint(6)
unsigned
 900100
clientSubacc CCBill Merchant Sub Account Number. smallint(4)
unsigned
zerofill		 0000
timestamp Time the event occurred. date 2012‐08‐05 15:18:17
firstName The first name of the consumer. string John
lastName The last name of the consumer string Doe
address1 Consumer address. varchar(30) 123 Main Street
city Consumer city. varchar(30) Anytown
state Consumer state. varchar(20) AZ
country Consumer country. varchar(30) US
postalCode Consumer ZIP Code. varchar(10) 50115
email Consumer Email address. varchar(40) user@randomurl.com
phoneNumber Consumer phone number; appears as entered by consumer. varchar(20) (515) 555-1212
ipAddress Consumer IP Address varchar(31) 192.168.27.4
reservationId Consumer’s subscription Reservation ID number. bigint(20)
unsigned		 0109072310330002423
username Consumer username. varchar(16) username1
password Consumer password. varchar(30) mYPaSSw0rD
formName Three (or more) character code for the CCBill form. char(255) 13cc
flexId Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used. UUID(36) cb617dcc-8467-49ab-b3a7-735ce1d60ad9
productDesc Description of the product purchased. varchar(50) Sample product description text.
priceDescription Initial Price Description. string 10.00(USD) for 10 days (trial) then 10.00(USD) recurring every 30 days
recurringPriceDescription The price to be charged on subsequent rebill dates. string 22.22(USD) recurring every 30 days
billedInitialPrice The initial price of the subscription. string 4.95
billedRecurringPrice Recurring price of the subscription. string 19.95
billedCurrencyCode Three‐digit currency in which the consumer was billed. int(3) 978 (see Appendix A for a list of Currency Codes.)
subscriptionInitialPrice The initial price of the subscription. decimal(9,2) 4.99
subscriptionRecurringPrice The recurring price of the subscription. decimal(7,2) 4.99
subscriptionCurrencyCode Three‐digit currency in which the consumer will be rebilled. int(3) 978 (see Appendix A for a list of Currency Codes.)
accountingInitialPrice The initial price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingRecurringPrice The recurring price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingCurrencyCode Three‐digit currency in which the Merchant will be paid. int(3) 840 (see Appendix A for a list of Currency Codes.)
initialPeriod The initial period of the subscription (in days). smallint(4)
unsigned		 7
recurringPeriod The recurring period of the subscription (in days). smallint(4)
unsigned		 30
rebills The total number of rebills for the subscription. tinyint(2)
unsigned		 12
nextRenewalDate Next billing date for recurring subscriptions string 2012-09-19
subscriptionTypeId Subscription Type ID number identifying the price point used in the transaction. int(10) 0000060748
dynamicPricingValidationDigest Hash digest of a Dynamic Pricing response. If not using Dynamic Pricing, this value will return as a blank string. string(32) s4f5198jgd21a4pk1p2s7sd23lm58937
paymentType The payment type used for the transaction. string Possible Values: CREDIT, CHECK, TELEPHONE, or DPEU
cardType Credit Card type used for a CREDIT transaction. Only displays if payment type = CREDIT. string VISA, MASTERCARD, DISCOVER, JCB, AMEX, OTHER
bin BIN of the Credit Card used mediumint(6)
unsigned		 510510
prePaid Indicates whether a prepaid card was used for payment. string 0, 1
last4 Last 4 digits of the Credit Card number or Banking Account number. smallint(4) unsigned zerofill 5100
expDate Expiration Date for Credit Card or Payment Card provided. smallint(4) unsigned zerofill 0217
(MMYY)
avsResponse The Response Code sent from the Address Verification system. Only displays if payment type = CREDIT. string Y
cvv2Response The Response Code sent from the CVV2 Verification System. Only displays if payment type = CREDIT. string M
affiliateSystem Indicates the Affiliate System used. string LTS
WMS
Miscellaneous
referringUrl URL from which the transaction was referred. string http://www.referringurl.biz
lifeTimeSubscription Indicates if the transaction is a Lifetime Subscription. Is not posted if not positive. int 1
lifeTimePrice Indicates the price paid for a lifetime subscription. string 40.25
Pass-through Key/Values Pass-through value pairs are passed with this post, if they exist. string Varies. Multiple pass-through sets can be sent.
paymentAccount Field must be configured by CCBill for data to be sent. alpha-numeric hash 57bc7327b5d721d7d20b240c0357e6ed
threeDSecure Indicates whether 3DS authentication was successful or not. string NOT_APPLICABLE, AUTH_SUCCESS, AUTH_ATTEMPTED, AUTH_FAILED, AUTH_UNAVAILABLE

Version 7

Supported Formats: URL Encoded, JSON

Released on 2025-02-17, this version includes optimizations and improvements to webhook event message processing. No new parameters have been introduced in this release.

Variable Name Description Data Type
(Max Length)		 Example Value
subscriptionId Subscription ID Number. bigint(20) unsigned 1000000000
transactionId Transaction identification number. string 0912191101000000159
clientAccnum CCBill Merchant main account number. mediumint(6)
unsigned
 900100
clientSubacc CCBill Merchant Sub Account Number. smallint(4)
unsigned
zerofill		 0000
timestamp Time the event occurred. date 2012‐08‐05 15:18:17
firstName The first name of the consumer. string John
lastName The last name of the consumer string Doe
address1 Consumer address. varchar(30) 123 Main Street
city Consumer city. varchar(30) Anytown
state Consumer state. varchar(20) AZ
country Consumer country. varchar(30) US
postalCode Consumer ZIP Code. varchar(10) 50115
email Consumer Email address. varchar(40) user@randomurl.com
phoneNumber Consumer phone number; appears as entered by consumer. varchar(20) (515) 555-1212
ipAddress Consumer IP Address varchar(31) 192.168.27.4
reservationId Consumer’s subscription Reservation ID number. bigint(20)
unsigned		 0109072310330002423
username Consumer username. varchar(16) username1
password Consumer password. varchar(30) mYPaSSw0rD
formName Three (or more) character code for the CCBill form. char(255) 13cc
flexId Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used. UUID(36) cb617dcc-8467-49ab-b3a7-735ce1d60ad9
productDesc Description of the product purchased. varchar(50) Sample product description text.
priceDescription Initial Price Description. string 10.00(USD) for 10 days (trial) then 10.00(USD) recurring every 30 days
recurringPriceDescription The price to be charged on subsequent rebill dates. string 22.22(USD) recurring every 30 days
billedInitialPrice The initial price of the subscription. string 4.95
billedRecurringPrice Recurring price of the subscription. string 19.95
billedCurrencyCode Three‐digit currency in which the consumer was billed. int(3) 978 (see Appendix A for a list of Currency Codes.)
subscriptionInitialPrice The initial price of the subscription. decimal(9,2) 4.99
subscriptionRecurringPrice The recurring price of the subscription. decimal(7,2) 4.99
subscriptionCurrencyCode Three‐digit currency in which the consumer will be rebilled. int(3) 978 (see Appendix A for a list of Currency Codes.)
accountingInitialPrice The initial price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingRecurringPrice The recurring price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingCurrencyCode Three‐digit currency in which the Merchant will be paid. int(3) 840 (see Appendix A for a list of Currency Codes.)
initialPeriod The initial period of the subscription (in days). smallint(4)
unsigned		 7
recurringPeriod The recurring period of the subscription (in days). smallint(4)
unsigned		 30
rebills The total number of rebills for the subscription. tinyint(2)
unsigned		 12
nextRenewalDate Next billing date for recurring subscriptions string 2012-09-19
subscriptionTypeId Subscription Type ID number identifying the price point used in the transaction. int(10) 0000060748
dynamicPricingValidationDigest Hash digest of a Dynamic Pricing response. If not using Dynamic Pricing, this value will return as a blank string. string(32) s4f5198jgd21a4pk1p2s7sd23lm58937
paymentType The payment type used for the transaction. string Possible Values: CREDIT, CHECK, TELEPHONE, or DPEU
cardType Credit Card type used for a CREDIT transaction. Only displays if payment type = CREDIT. string VISA, MASTERCARD, DISCOVER, JCB, AMEX, OTHER
bin BIN of the Credit Card used mediumint(6)
unsigned		 510510
prePaid Indicates whether a prepaid card was used for payment. string 0, 1
last4 Last 4 digits of the Credit Card number or Banking Account number. smallint(4) unsigned zerofill 5100
expDate Expiration Date for Credit Card or Payment Card provided. smallint(4) unsigned zerofill 0217
(MMYY)
avsResponse The Response Code sent from the Address Verification system. Only displays if payment type = CREDIT. string Y
cvv2Response The Response Code sent from the CVV2 Verification System. Only displays if payment type = CREDIT. string M
affiliateSystem Indicates the Affiliate System used. string LTS
WMS
Miscellaneous
referringUrl URL from which the transaction was referred. string http://www.referringurl.biz
lifeTimeSubscription Indicates if the transaction is a Lifetime Subscription. Is not posted if not positive. int 1
lifeTimePrice Indicates the price paid for a lifetime subscription. string 40.25
Pass-through Key/Values Pass-through value pairs are passed with this post, if they exist. string Varies. Multiple pass-through sets can be sent.
paymentAccount Field must be configured by CCBill for data to be sent. alpha-numeric hash 57bc7327b5d721d7d20b240c0357e6ed
threeDSecure Indicates whether 3DS authentication was successful or not. string NOT_APPLICABLE, AUTH_SUCCESS, AUTH_ATTEMPTED, AUTH_FAILED, AUTH_UNAVAILABLE

Version 8

Supported Formats: URL Encoded, JSON

Version 8 was released on 2025-04-29 and the cardSubType field was added to specify the card type used in the transaction.

Variable Name Description Data Type
(Max Length)		 Example Value
subscriptionId Subscription ID Number. bigint(20) unsigned 1000000000
transactionId Transaction identification number. string 0912191101000000159
clientAccnum CCBill Merchant main account number. mediumint(6)
unsigned
 900100
clientSubacc CCBill Merchant Sub Account Number. smallint(4)
unsigned
zerofill		 0000
timestamp Time the event occurred. date 2012‐08‐05 15:18:17
firstName The first name of the consumer. string John
lastName The last name of the consumer string Doe
address1 Consumer address. varchar(30) 123 Main Street
city Consumer city. varchar(30) Anytown
state Consumer state. varchar(20) AZ
country Consumer country. varchar(30) US
postalCode Consumer ZIP Code. varchar(10) 50115
email Consumer Email address. varchar(40) user@randomurl.com
phoneNumber Consumer phone number; appears as entered by consumer. varchar(20) (515) 555-1212
ipAddress Consumer IP Address varchar(31) 192.168.27.4
reservationId Consumer’s subscription Reservation ID number. bigint(20)
unsigned		 0109072310330002423
username Consumer username. varchar(16) username1
password Consumer password. varchar(30) mYPaSSw0rD
formName Three (or more) character code for the CCBill form. char(255) 13cc
flexId Displays the Flex ID of a form if the form used is a FlexForm, does not appear if a FlexForm is not used. UUID(36) cb617dcc-8467-49ab-b3a7-735ce1d60ad9
productDesc Description of the product purchased. varchar(50) Sample product description text.
priceDescription Initial Price Description. string 10.00(USD) for 10 days (trial) then 10.00(USD) recurring every 30 days
recurringPriceDescription The price to be charged on subsequent rebill dates. string 22.22(USD) recurring every 30 days
billedInitialPrice The initial price of the subscription. string 4.95
billedRecurringPrice Recurring price of the subscription. string 19.95
billedCurrencyCode Three‐digit currency in which the consumer was billed. int(3) 978 (see Appendix A for a list of Currency Codes.)
subscriptionInitialPrice The initial price of the subscription. decimal(9,2) 4.99
subscriptionRecurringPrice The recurring price of the subscription. decimal(7,2) 4.99
subscriptionCurrencyCode Three‐digit currency in which the consumer will be rebilled. int(3) 978 (see Appendix A for a list of Currency Codes.)
accountingInitialPrice The initial price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingRecurringPrice The recurring price, in USD, that the Merchant receives for the subscription. decimal(9,2) 4.99
accountingCurrencyCode Three‐digit currency in which the Merchant will be paid. int(3) 840 (see Appendix A for a list of Currency Codes.)
initialPeriod The initial period of the subscription (in days). smallint(4)
unsigned		 7
recurringPeriod The recurring period of the subscription (in days). smallint(4)
unsigned		 30
rebills The total number of rebills for the subscription. tinyint(2)
unsigned		 12
nextRenewalDate Next billing date for recurring subscriptions string 2012-09-19
subscriptionTypeId Subscription Type ID number identifying the price point used in the transaction. int(10) 0000060748
dynamicPricingValidationDigest Hash digest of a Dynamic Pricing response. If not using Dynamic Pricing, this value will return as a blank string. string(32) s4f5198jgd21a4pk1p2s7sd23lm58937
paymentType The payment type used for the transaction. string Possible Values: CREDIT, CHECK, TELEPHONE, or DPEU
cardType Credit Card type used for a CREDIT transaction. Only displays if payment type = CREDIT. string VISA, MASTERCARD, DISCOVER, JCB, AMEX, OTHER
bin BIN of the Credit Card used mediumint(6)
unsigned		 510510
prePaid Indicates whether a prepaid card was used for payment. string 0, 1
last4 Last 4 digits of the Credit Card number or Banking Account number. smallint(4) unsigned zerofill 5100
expDate Expiration Date for Credit Card or Payment Card provided. smallint(4) unsigned zerofill 0217
(MMYY)
avsResponse The Response Code sent from the Address Verification system. Only displays if payment type = CREDIT. string Y
cvv2Response The Response Code sent from the CVV2 Verification System. Only displays if payment type = CREDIT. string M
affiliateSystem Indicates the Affiliate System used. string LTS
WMS
Miscellaneous
referringUrl URL from which the transaction was referred. string http://www.referringurl.biz
lifeTimeSubscription Indicates if the transaction is a Lifetime Subscription. Is not posted if not positive. int 1
lifeTimePrice Indicates the price paid for a lifetime subscription. string 40.25
Pass-through Key/Values Pass-through value pairs are passed with this post, if they exist. string Varies. Multiple pass-through sets can be sent.
paymentAccount Field must be configured by CCBill for data to be sent. alpha-numeric hash 57bc7327b5d721d7d20b240c0357e6ed
threeDSecure Indicates whether 3DS authentication was successful or not. string NOT_APPLICABLE, AUTH_SUCCESS, AUTH_ATTEMPTED, AUTH_FAILED, AUTH_UNAVAILABLE
cardSubType The value specifies the card type used in the transaction string CREDIT, DEBIT, or OTHER

Appendix A: Currency Codes

Currency Numeric CodeCurrency Letter CodeCurrency Name
036AUDAustralian Dollar
124CADCanadian Dollar
392JPYJapanese Yen
826GBPUnited Kingdom Pound
840USDUnited States Dollar
978EUREuro Member Countries

Appendix B: Decline Codes

Decline CodeDecline Text
1Website is not available for signup
2Unable to determine website signup requirements
3Your card type is not accepted, please try another type of credit card
4Banking System Error
5The credit card you entered is not valid
6Please check to ensure you entered your expiration date. Used to show individual corresponding yearly, monthly or daily dates for report data. The date function's format is year-month-day; for example, 2002-01-01. correctly
7Please check to ensure you entered your bank account number correctly
8Please check to ensure you entered your bank's routing number correctly
9Banking System Error, please try again
10Website has invalid pricing
11Transaction Declined
12You currently have a subscription and are unable to signup
13You have already had a free trial
14You must enter your CVV2 number on the back of your card
15Your account is currently being processed, please check the website you are joining to see if you have access. If not, please contact support@ccbill.com
16Subscription ID Provided is invalid
17Subscription ID does not exist in system
18Previous Transaction Attempt in request was declined
19You are not authorized to signup with the provided credentials
20No Decline
21You have already had a trial, please select a normal recurring membership option
22Error contacting bank, please try again later
23Invalid Credit Card Provided
24Transaction Denied by Bank
25Bank Error
26Card Processing Setup Incorrect for Merchant
27System Error, Please Try Again
28We are unable to process your transaction at this time. Please try again at a later time
29Card Expired
30We are unable to bill the telephone number provided for this transaction. Please return to the website and choose an alternate payment method.
31Insufficient Funds
32You must provide CVV2 to complete transaction
33Unable to determine transaction type
34Error contacting bank, please try again later
35Card Declined at Pre-Auth SC
36Unable To Contact Bank
37We currently do not process for your bank's bin
38Transaction Refused by Issuing Bank
39You Have Submitted Too Many Times Today
40The Card you are using is not accepted by this Merchant
41Merchant Inactive
42Incorrect Address Provided
43We are unable to process your telephone billing transaction because your provider only allows for one charge, per telephone number, per day, and our records show that you have an existing daily charge to this telephone number. Please return to the website and choose an alternative payment method.
44We're sorry, at this time prepaid cards are not allowed. Please try a different card type.
45Transaction requires additional approval: please refer to your confirmation e-mail for further instructions.

Changelog

Release 12 - 2025-04-29

The cardSubType parameter was added to specify the card type used in the transaction.

Affected Webhooks

  • CrossSaleFailure (v5)
  • CrossSaleSuccess (v6)
  • NewSaleFailure (v5)
  • NewSaleSuccess (v8)
  • RenewalFailure (v5)
  • RenewalSuccess (v7)
  • UpgradeFailure (v4)
  • UpgradeSuccess (v5)
  • UpSaleFailure (v5)
  • UpSaleSuccess (v7)

Release 11 - 2025-02-17

Enhancements

  • Webhook event processing optimized.
  • No new parameters introduced.

Updated Event Versions

  • Void (v5)
  • BillingDateChange (v2)
  • Cancellation (v2)
  • Chargeback (v5)
  • CrossSaleFailure (v4)
  • CrossSaleSuccess (v5)
  • CustomerDataUpdate (v5)
  • Expiration (v2)
  • ManualAdd (v2)
  • NewSaleFailure (v4)
  • NewSaleSuccess (v7)
  • Refund (v5)
  • RenewalFailure (v4)
  • RenewalSuccess (v6)
  • Return (v5)
  • UpgradeFailure (v3)
  • UpgradeSuccess (v4)
  • UpSaleFailure (v4)
  • UpSaleSuccess (v6)
  • UserReactivation (v2)

Release 10 - 2022-04-21

Two new parameters were added to support 3DS authentication results.

New Parameters

  • paymentAccount
  • scaResponseStatus

Affected Webhooks

paymentAccount added to:

  • CrossSaleFailure (v3)
  • CrossSaleSuccess (v4)
  • UpSaleFailure (v3)
  • UpgradeFailure (v2)
  • UpgradeSuccess (v3)

scaResponseStatus added to:

  • CrossSaleFailure (v3)
  • CrossSaleSuccess (v4)
  • UpSaleFailure (v3)
  • UpSaleSuccess (v5)
  • UpgradeFailure (v2)
  • UpgradeSuccess (v3)

Release 9 - 2020-02-11

Added new parameter for tracking 3DS authentication results.

New Parameter

  • threeDSecure

Affected Webhooks

  • NewSaleSuccess (v6)
  • NewSaleFailure (v3)

Release 8 - 2019-07-23

New Parameters

  • expDate
  • last4
  • paymentAccount

Affected Webhooks

  • UpSaleSuccess (v4)

Release 7 - 2017-7-19

New Feature

Webhook delivery now supports JSON format in addition to URL Encoded.

Release 6 - 2017-06-01

New Parameters

  • paymentAccount
  • accountingCurrency
  • currency
  • billedCurrency

Affected Webhooks

paymentAccount added to:

  • CustomerDataUpdate (v4)
  • Chargeback (v4)
  • Refund (v4)
  • Return (v4)
  • RenewalSuccess (v5)
  • Void (v4)

accountingCurrency added to:

  • Chargeback (all versions)
  • Refund (all versions)
  • RenewalSuccess (all versions)
  • Void (all versions)

currency added to:

  • Chargeback (all versions)
  • Refund (all versions)
  • Void (all versions)

billedCurrency added to:

  • RenewalSuccess (all versions)

Release 5 - 2017-05-11

Three new parameters were added to enable merchants to track the card BIN, payment method, and type of card used.

New Parameters

  • bin
  • paymentType
  • cardType

Affected Webhooks

bin added to:

  • NewSaleSuccess (v5)
  • UpgradeSuccess (v2)
  • UpSaleSuccess (v3)
  • CrossSaleSuccess (v3)
  • CustomerDataUpdate (v3)
  • Chargeback (v3)

paymentType added to:

  • Chargeback (v3)
  • Return (v3)
  • Refund (v3)
  • RenewalSuccess (v4)
  • RenewalFailure (v3)
  • Void (v3)

cardType added to:

  • Chargeback (v3)
  • Refund (v3)
  • RenewalSuccess (v4)
  • RenewalFailure (v3)
  • Void (v3)

Release 4 - 2017-04-13

Security Enhancement

TLS 1.2 support added for secure transmission.

New Parameters

  • expDate Provides card expiration date.
  • last4 Returns last 4 digits of card/bank account.

Affected Webhooks

  • NewSaleSuccess (v4)
  • CustomerDataUpdate (v2)
  • Chargeback (v2)
  • Refund (v2)
  • RenewalSuccess (v3)
  • Void (v2)

Release 3 - 2014-04-24

New Feature

Added flexId variable to support FlexForms (Open Beta). The field only appears for FlexForm transactions.

Affected Webhooks

  • NewSalesSuccess (v3)
  • NewSalesFailure (v2)
  • Notes were added to related Webhooks (UpSaleSuccess, UpSaleFailure, CrossSaleSuccess, CrossSaleFailure) to reference the correct base versions.

Release 2 - 2013-10-30

New Features

  • Introduced versioning support for configurations and events.
  • Older configurations prompt upgrade option.

New Webhooks Event

  • Return - Notifies users of check returns.

New Parameters

  • paymentAccount
  • renewalDate

Affected Webhooks

paymentAccount field added to:

  • NewSaleSuccess (v2)

renewalDate field added to:

  • RenewalSuccess (v2)
  • RenewalFailure (v2)

Bug Fixes

  • Fixes a bug that resulted in incorrect POST of the failureCode, failureReason, and transactionId fields in CrossSales, CrossSaleAPI, and Upgrades with specialOffer.
  • Fixes a bug that resulted in incorrect POST of failureCode, failureReason, and transactionId fields for Upsales.
  • Fixes a bug that caused the subscriptionTypeId to be incorrectly sent.

Release 1 - Initial Release

No notable changes included.