RecurringBilling

Description

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

Properties

Type

Name

Description

decimal

Amount

Amount for each recurring bill.

decimal

Tax

Rate of tax applied to the amount.

bool

Enabled

Whether recurring billing is enabled for the associated Customer.

dateTime

Start

Date and time the recurring billing cycle starts.

Format: YYYY-MM-DD

dateTime

Expire

Date and time the recurring billing cycle ends.

Format: YYYY-MM-DD

dateTime

Next

Date and time of the next recurring bill.

Note: Currently not in use.

string

NumLeft

Remaining number of recurring bills.

int

RepeatCount

Total number of recurring bills.

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

Custom schedule for the recurring bill.

string

ScheduleName

Name of the schedule.

string

ReceiptNote

Note to include on the receipt.

string

ReceiptTemplateName

Name of the email template to use for the receipt.

bool

SendCustomerReceipt

Whether to send receipts to the customer.

string

CustomerEmailList

Customer email addresses associated with the recurring bill.