developer:soap-1.6:objects:recurringbilling

Table of Contents

Soap API v1.6

RecurringBilling

This object stores information relating to specific recurring billing cycles.

Description

It includes the frequency, amount, start and end dates of the recurring billing schedule.

Properties

Type Name Description
string Schedule Frequency of recurring billing schedule. Possible values include: disabled, daily, weekly, bi-weekly (every two weeks), monthly, bi-monthly (every two months), quarterly, bi-annually (every six months), annually.
string Next Date this customer will be billed next. Must be formatted Year-Month-Day (ie 2011-07-04)
string Expire Date this billing entry will be disabled.
integer NumLeft Number of transactions remaining in recurring billing cycle. (Overrides the Expire parameter)
double Amount Amount to be billed in each transaction.
boolean Enabled Notes whether customer is currently enabled for recurring billing.

Places Used

TransactionRequestObject

Examples

.NET VB

Dim recurring As usaepay.RecurringBilling = New usaepay.RecurringBilling
        recurring.Amount = 10.0
        recurring.Enabled = True
        recurring.Next = "2010-09-01"
        recurring.NumLeft = "5"
        recurring.Schedule = "monthly"
 
        tran.RecurringBilling = recurring

.NET C#

tran.RecurringBilling = new usaepay.RecurringBilling();
            tran.RecurringBilling.Amount = 10.00;
            tran.RecurringBilling.Schedule = "bi-monthly";
            tran.RecurringBilling.Next = "2010-09-01";
            tran.RecurringBilling.NumLeft = "5";
            tran.RecurringBilling.Enabled = true;

Change History

Version Change
1.1 Method added prior to soap-1.1
developer/soap-1.6/objects/recurringbilling.txt · Last modified: 2015/06/29 15:38 by yura

Page Tools