Contract Options Reference

A comprehensive reference guide explaining the various options that can be configured for contracts and subscriptions.

General Settings

The General Settings section defines the core identifying information and basic configurations for a contract/subscription. These fields determine how the contract appears throughout the system, which customer it's associated with, and whether the contract is active.

Field NameDescription
CustomerDrop-down menu for selecting a pre-created customer to associate with the contract.
NameField for entering a custom name for the contract.
DescriptionField for entering a description of the contract being created.
Is ActiveEnables or disables the contract from executing.

Per Bill Invoice

The Per Bill Invoice section is where merchants designate the total amount a customer will be billed each time their associated contract executes.

Field NameDescription
SubtotalThe base amount to bill each time the contract executes.
TaxThe tax amount to add to the base amount each time the contract executes.
TotalThe total amount that will be charged to the customer's payment method each time the contract executes.

Thresholds

The Thresholds section allows customers to define thresholds and actions for failed and successful contract executions.

Field NameDescription
Max AmountThe maximum amount billed before this contract is automatically disabled.
Max Payments (Count)The maximum number of payments completed before this contract is automatically deactivated.
Max Successful BillsThe maximum number of successful executions before this contract is automatically deactivated.
Max Failed ExecutionsThe maximum number of failed executions before this contract is automatically deactivated (0 = do not reprocess).
Failure IntervalThe interval over which max failures is calculated.
Failure PeriodThe period of time over which max failures is calculated.

Schedule

The Schedule section is where merchants designate the frequency at which a contract will execute. Options include Daily, Weekly, Monthly, and Yearly.

Daily Frequency Reference

Field NameDescription
Repeat EveryFrequency at which the contract will execute, measured in days.
EndProvides options for merchants to stop a contract from executing. Options include Never, After "X" occurrence(s), and On a specific date.

Weekly Frequency Reference

Field NameDescription
Repeat EveryFrequency at which the contract will execute, measured in weeks.
Repeat OnAllows merchants to select a day of the week on which the contract will execute.
EndProvides options for merchants to stop a contract from executing. Options include Never, After "X" occurrence(s), and On a specific date.

Monthly Frequency Reference

Field NameDescription
Repeat EveryFrequency at which the contract will execute, measured in months.
Repeat OnAllows merchants to select which day of the month the contract will execute.
WeekdayAllows merchants to select between a specific day, weekday, or weekend day on which the contract will execute.
EndProvides options for merchants to stop a contract from executing. Options include Never, After "X" occurrence(s), and On a specific date.

Yearly Frequency Reference

Field NameDescription
Repeat EveryFrequency at which the contract will execute, measured in years.
Repeat OnAllows merchants to choose which month and day the contract will execute.
EndProvides options for merchants to stop a contract from executing. Options include Never, After "X" occurrence(s), and On a specific date.

Payment Method

The Payment Method section is where merchants add the payment information that will be used for the contract.

Merchants have the option to use a card or checking account.

Card Option Field Reference

Field NameDescription
Account NumberCredit card number.
Expiration DateExpiration date of the credit card.
Address1Street address of the primary cardholder.
Address2Apartment number of the primary cardholder.
CityCity of the primary cardholder.
StateState of the primary cardholder.
ProvinceProvince of the primary cardholder.
ZipZip code of the primary cardholder.
Postal CodePostal code of the primary cardholder.
CountryCountry of the primary cardholder.
Is MailingToggle to indicate whether the entered information is the mailing address of the primary cardholder.
Is DefaultToggle to set this as the default payment method for the contract.
Cardholder NameName of the primary cardholder.

Email Notifications

Options to enable Email Notifications to be sent to the customer or merchant when a contract executes successfully or fails.

Field NameDescription
Email customer on approvalToggle to enable email notifications to the customer when a contract executes successfully.
Email customer on failureToggle to enable email notifications to the customer when a contract fails to execute.
Email merchant on approvalToggle to enable email notifications to the merchant when a contract executes successfully.
Email merchant on failureToggle to enable email notifications to the merchant when a contract fails to execute.