Developer Information

• Introduction

• Customer Self Service
• Callback URL
• Billing Circle Connect API
  • Understanding Bill Types

Connect API

• API Introduction
• Client Records
  • Create Client
  • Confirm Client
  • Modify Client
  • Delete Clients
  • Create Note
  • Verify Client Billing
  • Check Client Status
  • Fetch Client Data
  • Search Client Data
• Billing Schedules
  • Create Schedule
  • Confirm Schedule
  • Modify Schedule
  • Delete Schedule
  • Create Adjustment
  • Check Schedule Status
  • Fetch Schedule Data
• Reporting Data
  • Report Transactions
  • Report Due
• Understanding Responses
  • Response Codes

Resources

• Sample Code

Modify Schedule

The modifyschedule Method allows the merchant to modify a previously created billing schedule associated with a client. All NAME/VALUE pairs from the createschedule Method are allowed as well as s_status.

Field	Required	Value	Max Length	Description
method	Required	modifyschedule	N/A	Indicates the function the merchant wishes to perform.
companyid	Required	Varies by merchant	30	Issued by Billing Circle.
username	Required	Varies by merchant	30	Any Admin level account defined within Billing Circle.
password	Required	Varies by merchant	100	Password associated with username field.
c_merchantid	Conditional	Any unique value	255	The "merchantid" allows a merchant to refer to a client record by their own proprietary key as defined within their database. This value is required if a "clientid" is not submitted.
c_clientid	Conditional	Integer	N/A	The "clientid" is an integer value returned after a successful createclient post. This value is required if a "merchantid" is not submitted.
s_scheduleid	Required	Integer	N/A	The scheduleid is the value returned after a successful createschedule submission. This value must be stored and will be used for all future reference to this billing schedule.
s_startdate	Optional	YYYY-MM-DD	10	Date billing begins. Date must be equal to or greater than the current date during the post.
s_recurringtype	Optional	subscription, installments, single	N/A	Defines recurring billing type.
s_title	Optional	Any String	100	Text describing charge. This value will be visible to customers who receive automated emails or are allowed to check their account online.
s_lineitems	Optional	Pipe Separated Strings	N/A	This optional data will be displayed as lineitems on the customer's email receipts and Account page. Individual line items should be sent separated by the pipe symbol "|".
s_interval	Optional	yearly, quarterly, monthly, semimonthly, weekly	N/A	Defines recurring billing interval. Required for s_recurringtype values "subscription" and "installments".
s_numofintervals	Optional	Integer	N/A	Defines number of recurring billing intervals. Required for s_recurringtype value "installments" only. For "installments" any number greater than 1 is accepted. For "subscription" any number greater than 2 is accepted, or omit for indefinite billing.
s_amount	Optional	Double	N/A	Defines the pre-tax recurring charge. For installment billing this value is evenly divided among the number of billing intervals. Any remainder will be added to the first billing.
s_taxrate	Optional	Double	99.9	Tax rate percentage to be applied to s_amount total.
s_status	Optional	active, inactive	N/A	Status of billing schedule. Only schedules set to status "active" will be processed.

• 

• Tour
• Sign Up
• Clients
• About
• Support
• Blog
• Site Map
• © 2012 Billing Circle