PayTo

Payment terms

Every agreement carries a payment_terms object that defines what payments may be initiated against it. The type field selects one of four patterns, and the other fields available depend on that type.

type	Description
fixed	The same fixed amount is debited each time.
variable	The amount varies each time, up to an optional maximum.
usage_based	Usage-based billing, up to an optional maximum.
balloon	A recurring amount with distinct first and/or last payment amounts.

Fields by type

Field	fixed	variable	usage_based	balloon
type	required	required	required	required
frequency	required	required	required	required
count	optional	optional	optional	optional
amount	required	—	—	required
max_amount	—	optional	optional	—
first_payment_amount	—	—	—	optional
last_payment_amount	—	—	—	optional
first_payment_date	optional	optional	optional	optional
last_payment_date	optional	optional	optional	optional

Notes:

• Amounts are integers in cents (1 to 1,000,000,000).
• A field marked "—" is rejected for that term type.
• count is the number of payments allowed per frequency period. With a non-adhoc frequency and no count, one payment per period is allowed; with adhoc frequency and no count, unlimited payments are allowed.
• Payment dates use the Australia/Sydney timezone. When both are supplied, first_payment_date must be on or before last_payment_date, and both must fall within the agreement's validity window (start_date / end_date).