The fetchschedule method allows the merchant to fetch all billing schedule information, such as intervals, title, amount, etc. Data is returned as a URL encoded query string. Note that optional "lineitems" are pipe (|) seperated if multiple lineitems exist. Each schedule will be indexed numerically beginning at 1.
Example: scheduleid1=1234&interval1=monthly&recurringtype1=subscription&amount1=29.00&taxrate1=0.000&startdate1=2007-08-15&enddate1=0000-00-00&title1=My+Service+Charge&status1=active
| Field | Required | Value | Max Length | Description |
|---|---|---|---|---|
| method | Required | fetchschedule | 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. For all methods, excluding createclient, the "merchantid" can be omitted if the "clientid" is submitted. Each client record must have a unique merchantid. |
| c_clientid | Conditional | Integer | N/A | The "clientid" is the key created by Billing Circle to refer to a client record. It is returned by Billing Circle after processing a successful createclient request. For all methods, excluding createclient (where a "clientid" is not applicable), the "clientid" can be omitted if the "merchantid" is submitted. |
Members Login 