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 Name | Description |
|---|---|
| Customer | Drop-down menu for selecting a pre-created customer to associate with the contract. |
| Name | Field for entering a custom name for the contract. |
| Description | Field for entering a description of the contract being created. |
| Is Active | Enables 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 Name | Description |
|---|---|
| Subtotal | The base amount to bill each time the contract executes. |
| Tax | The tax amount to add to the base amount each time the contract executes. |
| Total | The 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 Name | Description |
|---|---|
| Max Amount | The 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 Bills | The maximum number of successful executions before this contract is automatically deactivated. |
| Max Failed Executions | The maximum number of failed executions before this contract is automatically deactivated (0 = do not reprocess). |
| Failure Interval | The interval over which max failures is calculated. |
| Failure Period | The 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 Name | Description |
|---|---|
| Repeat Every | Frequency at which the contract will execute, measured in days. |
| End | Provides 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 Name | Description |
|---|---|
| Repeat Every | Frequency at which the contract will execute, measured in weeks. |
| Repeat On | Allows merchants to select a day of the week on which the contract will execute. |
| End | Provides 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 Name | Description |
|---|---|
| Repeat Every | Frequency at which the contract will execute, measured in months. |
| Repeat On | Allows merchants to select which day of the month the contract will execute. |
| Weekday | Allows merchants to select between a specific day, weekday, or weekend day on which the contract will execute. |
| End | Provides 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 Name | Description |
|---|---|
| Repeat Every | Frequency at which the contract will execute, measured in years. |
| Repeat On | Allows merchants to choose which month and day the contract will execute. |
| End | Provides 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 Name | Description |
|---|---|
| Account Number | Credit card number. |
| Expiration Date | Expiration date of the credit card. |
| Address1 | Street address of the primary cardholder. |
| Address2 | Apartment number of the primary cardholder. |
| City | City of the primary cardholder. |
| State | State of the primary cardholder. |
| Province | Province of the primary cardholder. |
| Zip | Zip code of the primary cardholder. |
| Postal Code | Postal code of the primary cardholder. |
| Country | Country of the primary cardholder. |
| Is Mailing | Toggle to indicate whether the entered information is the mailing address of the primary cardholder. |
| Is Default | Toggle to set this as the default payment method for the contract. |
| Cardholder Name | Name 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 Name | Description |
|---|---|
| Email customer on approval | Toggle to enable email notifications to the customer when a contract executes successfully. |
| Email customer on failure | Toggle to enable email notifications to the customer when a contract fails to execute. |
| Email merchant on approval | Toggle to enable email notifications to the merchant when a contract executes successfully. |
| Email merchant on failure | Toggle to enable email notifications to the merchant when a contract fails to execute. |
Updated 4 months ago
