developer:recurringbilling

Recurring Billing

Overview

The Recurring Billing enables you to set up and monitor recurring billing cycles for multiple customers. Recurring billing cycles can be set to charge a customer's card automatically according whatever schedule you choose to set. Each time a recurring charge is run, a report is generated and a receipt sent to your email and the customer's email. You need to have this feature enabled for your USAePay account

Set up new customer

Customer Database and Recurring Billing
addcustomer Is required to be equal Yes for some APIs (all except SOAP). If set to yes and the transaction has been approved, the system will create a new customer record and store the payment information for future use. (Yes/No)
schedule How often to run the transaction. Possible values are: daily, weekly, biweekly, monthly, bimonthly, quarterly, biannually, annually. Default is monthly. If you do not want to enable recurring billing for this customer, set schedule=“disabled”
numleft The number of times to left in billing cycle. Either a number or * for unlimited. (default is *)
start When to start the schedule. Must be in YYYYMMDD format. To begin one billing period from today, set to “next.” (For example, if today is 5/1/2012 and schedule is “monthly” the recurring billing will start on 6/1/2012.) If left blank, default is “tomorrow.”
end When to stop running transactions. Default is to run forever. If both end and numleft are specified, transaction will stop when the earliest condition is met.
billamount Optional recurring billing amount. If not specified, the amount field will be used for future recurring billing charges.
billtax Optional recurring billing tax. If not specified, the tax field will be used for future recurring billing charges.
billsourcekey If set to true, for future recurring billing charges will be run using the same source key as the original transaction. By default recurring charges run using a source key labeled “Recurring”.

For SOAP XML API use addCustomer method.

Edit customer

Editing customers available through the Merchant Console and SOAP XML API.

Use quickCustomerUpdate to modify an existing customer or updateCustomer to replace all data for customer.

Delete customer

Editing customers available through the Merchant Console and SOAP XML API.

Use deleteCustomer to delete customer. Also, you can disable customer if you don't want customer to be charged, but want to keep payment and customer information in the database.

developer/recurringbilling.txt · Last modified: 2011/03/03 15:11 by irina

Page Tools