RecurringBilling

Description

The RecurringBilling object represents a recurring billing cycle within a Customer object.

Properties

TypeNameDescription
decimalAmountAmount for each recurring bill.
decimalTaxRate of tax applied to the amount.
boolEnabledWhether recurring billing is enabled for the associated Customer.
dateTimeStart

Date and time the recurring billing cycle starts.

Format: YYYY-MM-DD

dateTimeExpire

Date and time the recurring billing cycle ends.

Format: YYYY-MM-DD

dateTimeNext

Date and time of the next recurring bill.

Note: Currently not in use.

stringNumLeftRemaining number of recurring bills.
intRepeatCountTotal number of recurring bills.
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
CustomScheduleCustomScheduleObjectCustom schedule for the recurring bill.
stringScheduleNameName of the schedule.
stringReceiptNoteNote to include on the receipt.
stringReceiptTemplateNameName of the email template to use for the receipt.
boolSendCustomerReceiptWhether to send receipts to the customer.
stringCustomerEmailListCustomer email addresses associated with the recurring bill.