0

Closed

Support recurring.list

description

http://developers.freshbooks.com/docs/recurring/
 
recurring.list
 
Returns a list of recurring profile summaries. Results are ordered by descending recurring_id.
Note: A list request that returns no results (i.e. page 999), will return an empty result set, not an error.
Note: The response will include an empty autobill tag if the recurring profile does not have auto-billing enabled, otherwise the response will include an autobill element with the gateway name and card element.
Note: This method uses pagination.
 
Request
 
view plaincopy to clipboardprint?
 
  • <?xml version="1.0" encoding="utf-8"?> 
  • <request method="recurring.list"> 
  •    <!-- Filter by client (Optional) --> 
  •    <client_id>3</client_id> 
  •    <!-- Return auto-bills dated after this arg (Optional) --> 
  •    <date_from>2007-01-01</date_from> 
  •    <!-- Return auto-bills dated before this arg (Optional) --> 
  •    <date_to>2007-04-01</date_to> 
  •    <!-- Return invoices modified after this arg (Optional) --> 
  •    <updated_from>2007-01-01 00:00:00</updated_from> 
  •    <!-- Return invoices modified before this arg (Optional) --> 
  •    <updated_to>2007-01-02 00:00:00</updated_to> 
  •    <!-- Filter auto-bill profiles (Optional) --> 
  •    <autobill>1</autobill> 
  •    <!-- Page number to return, default is 1 (Optional) --> 
  •    <page>1</page> 
  •    <!-- Number of results per page, default is 25 (Optional) --> 
  •    <per_page>10</per_page> 
  •    <!--One of 'active', 'archived', 'deleted' (Optional) --> 
  •    <folder>active</folder> 
  • </request> 
     
    Response
     
    view plaincopy to clipboardprint?
     
  • <?xml version="1.0" encoding="utf-8"?> 
  • <response xmlns="http://www.freshbooks.com/api/" status="ok"> 
  •   <recurrings page="1" per_page="10" pages="5" total="48"> 
  •     <recurring> 
  •       <recurring_id>00000000001</recurring_id> 
  •       <!-- One of '2y', 'y', '6m', '3m', '2m', 'm', '4w', '2w', 'w' --> 
  •       <frequency>m</frequency> 
  •       <occurrences>0</occurrences> 
  •       <stopped>1</stopped> 
  •       <client_id>2</client_id> 
  •         <contacts> 
  •             <contact> 
  •                 <contact_id>30</contact_id> 
  •             </contact> 
  •         </contacts> 
  •       <staff_id>1</staff_id> 
  •       <organization>XYZ Widgets Ltd</organization> 
  •       <first_name>Joe</first_name> 
  •       <last_name>Smith</last_name> 
  •       <p_street1>2770 Dufferin St.</p_street1> 
  •       <p_street2>Suite 201</p_street2> 
  •       <p_city>Toronto</p_city> 
  •       <p_state>Ontario</p_state> 
  •       <p_country>Canada</p_country> 
  •       <p_code>M6B 3R7</p_code> 
  •           <vat_name></vat_name> 
  •           <vat_number></vat_number> 
  •       <po_number></po_number> 
  •       <status></status> 
  •       <amount>200</amount> 
  •           <currency_code>CAD</currency_code> 
  •           <language>en</language> 
  •       <date>2009-06-08</date> 
  •       <notes></notes> 
  •       <terms>Payment due in 30 days.</terms> 
  •       <discount>0</discount> 
  •       <return_uri></return_uri> 
  •       <send_snail_mail>0</send_snail_mail> 
  •       <send_email>1</send_email> 
  •           <folder>active</folder> 
  •       <autobill> 
  •         <gateway_name>Authorize.Net</gateway_name> 
  •         <card> 
  •           <number>************1111</number> 
  •           <name>John Smith</name> 
  •           <expiration> 
  •             <month>03</month> 
  •             <year>2012</year> 
  •           </expiration> 
  •         </card> 
  •       </autobill> 
  •       <lines> 
  •         <line> 
  •               <line_id>1</line_id>  <!-- (Read Only) line id --> 
  •           <name>Service</name> 
  •           <description>Monthly Subscription</description> 
  •           <unit_cost>200</unit_cost> 
  •           <quantity>1</quantity> 
  •           <amount>200</amount> 
  •           <tax1_name></tax1_name> 
  •           <tax2_name></tax2_name> 
  •           <tax1_percent>0</tax1_percent> 
  •           <tax2_percent>0</tax2_percent> 
  •           <type>Item</type> 
  •         </line> 
  •       </lines> 
  •     </recurring> 
  •     ... 
  •   </recurrings> 
  • </response>
Closed Jul 23, 2012 at 5:18 PM by stemarie

comments

wrote Jul 23, 2012 at 5:18 PM

Resolved with changeset 94086.

wrote Jan 31, 2013 at 11:24 PM

wrote May 13, 2013 at 6:24 PM