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

Understanding Bill Types

A billing "schedule" refers to a single recurring billing definition associated with a client. Each client may have zero or more billing schedules. The Billing Circle Connect API allows a merchant to create, modify, and delete all supported billing schedule types.

Subscription

Subscription schedules allow for billing to recur any number of times, or indefinitely until manually terminated. Supported intervals are weekly, monthly, quarterly, and yearly. Subscription Schedules require a start-date, an interval, a recurring billing value, and a title. Optionally the merchant may include a number of intervals (2 or greater) or if nothing is submitted billing will recur indefinitely.

Installments

Installment schedules allow for a total value to be evenly divided among any two or more billing intervals. Supported intervals are weekly, monthly, quarterly, and yearly. Installment Schedules require a start-date, an interval, a recurring billing value, a number of intervals, and a title. Note: If the billing total cannot be divided evenly among the number of intervals, the remainder will be added to the first bill.

Single

Single schedules charge a single time, for the full value on the date specified. Single Schedules can be helpful for unique charges not associated with any recurring schedule.

Special Considerations

There are a few special rules to keep in mind:

• Monthly and Quarterly billing can only begin on the 1st through the 28th of any month. Other start-dates will not be accepted.
• Quarterly billing occurs on the date specified, every 3 months. For instance a Quarterly bill with 4 intervals beginning on April 10th would charge on April 10th, July 10th, October 10th, and January 10th of the following year.
• Single Schedules can be used for recurring charges with no defined billing pattern. An expired Single Schedule can be rescheduled using a new start-date to bill again.
• A start-date must occur on or after the day the schedule is created.

• 

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