RecurringBillingDetails

Description

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

Properties

TypeNameDescription
stringScheduledPaymentInternalIdInternal identifier returned from the ScheduleRecurringPayment method.
stringCustomerInternalIdInternal identifier for the associated Customer object.
stringCustomerIdIdentifies the associated Customer object.
decimalAmountAmount (including tax) paid toward the associated Payment object.
decimalTaxRate of tax applied to the amount.
boolEnabledIndicates whether the Customer object is currently enabled for recurring billing.
dateTimeStartDate and time the recurring bill will start.
dateTimeExpireDate and time the recurring bill will end.
dateTimeNextDate and time of the next recurring bill.
stringNumLeftNumber of remaining recurring payments.
intRepeatCountNumber of times the recurring bill will be repeated.
stringScheduleFrequency 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
CustomScheduleCustomScheduleObjectCustomized schedule object.
stringScheduleNameName of the schedule.
stringReceiptNoteNotes to be added to the receipt.
stringReceiptTemplateNameEmail template to use for the receipt.
boolSendCustomerReceiptWhether the receipt should be sent to the customer.
stringCustNumCustomer reference number assigned by EBizCharge.
stringPaymentMethodIdIdentifies the associated PaymentMethodProfile object used for this recurring bill.
stringMaskedPMLast 4 digits of the card number or bank account.
stringPMHolderNameName associated to the card number or bank account.
stringPMExpirationYearExpiration year of the card number or bank account.
stringPMExpirationMonthExpiration month of the card number or bank account.
stringPmTypeCard number or bank account.
stringScheduleStatusStatus of the payment.
Possible Values

An integer from 0 to 3 (inclusive).

stringDateTimeCreatedDate and time the recurring bill was created.
stringDateTimeModifiedDate and time the recurring bill was modified.
stringCustomerFirstNameFirst name of the customer associated to the recurring bill.
stringCustomerLastNameLast name of the customer associated to the recurring bill.
stringCustomerCompanyNameCompany name of the customer associated to the recurring bill.
stringCustomerEmailListEmail of the customer associated to the recurring bill.