RecurringBillingDetails

Description

The RecurringBillingDetails object represents a recurring bill and contains all related information.

Properties

Type

Name

Description

string

ScheduledPaymentInternalId

Internal identifier returned from the ScheduleRecurringPayment method.

string

CustomerInternalId

Internal identifier for the associated Customer object.

string

CustomerId

Identifies the associated Customer object.

decimal

Amount

Amount (including tax) paid toward the associated Payment object.

decimal

Tax

Rate of tax applied to the amount.

bool

Enabled

Indicates whether the Customer object is currently enabled for recurring billing.

dateTime

Start

Date and time the recurring bill will start.

dateTime

Expire

Date and time the recurring bill will end.

dateTime

Next

Date and time of the next recurring bill.

string

NumLeft

Number of remaining recurring payments.

int

RepeatCount

Number of times the recurring bill will be repeated.

string

Schedule

Frequency of the recurring bill.

Possible Values
  • once
  • daily
  • weekly
  • bi-weekly (every two weeks)
  • four-week (every four weeks)
  • monthly
  • bi-monthly (every two months)
  • quarterly
  • bi-annually (every six months)
  • annually

CustomSchedule

CustomScheduleObject

Customized schedule object.

string

ScheduleName

Name of the schedule.

string

ReceiptNote

Notes to be added to the receipt.

string

ReceiptTemplateName

Email template to use for the receipt.

bool

SendCustomerReceipt

Whether the receipt should be sent to the customer.

string

CustNum

Customer reference number assigned by EBizCharge.

string

PaymentMethodId

Identifies the associated PaymentMethodProfile object used for this recurring bill.

string

MaskedPM

Last 4 digits of the card number or bank account.

string

PMHolderName

Name associated to the card number or bank account.

string

PMExpirationYear

Expiration year of the card number or bank account.

string

PMExpirationMonth

Expiration month of the card number or bank account.

string

PmType

Card number or bank account.

string

ScheduleStatus

Status of the payment.

Possible Values

An integer from 0 to 3 (inclusive).

string

DateTimeCreated

Date and time the recurring bill was created.

string

DateTimeModified

Date and time the recurring bill was modified.

string

CustomerFirstName

First name of the customer associated to the recurring bill.

string

CustomerLastName

Last name of the customer associated to the recurring bill.

string

CustomerCompanyName

Company name of the customer associated to the recurring bill.

string

CustomerEmailList

Email of the customer associated to the recurring bill.