RecurringBilling

This object stores information relating to specific recurring billing cycles.

Description

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:
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. (optional)

decimal

Amount

Amount to be billed in each transaction. (required)

decimal

Tax

Tax to be billed in each transaction. (required)

DateTime

Start

Date this billing entry will be started. (required)

DateTime

Expire

Date this billing entry will be disabled. (required)

string

ScheduleName

Schedule name (description) (optional)

bool

SendCustomerReceipt

Send customer receipt. (optional)

string

ReceiptTemplateName

Email template to use. (optional)

string

ReceiptNote

Notes to be added to receipt. (optional)

bool

Enabled

Whether customer is currently enabled for recurring billing. (required)