View Payment Plan

Type:    Form
Description: Allows to view and modify a new payment plan.
Items:


View Payment Plan

Includes options allowing to manage a payment plan.
¦_
Close
Closes the form without saving any changes.

Payment Plan

Includes payment plan general information.
¦_
Payment Plan ID
Identifier of the object used for references; auto-incremented integer value.

References: Payment Plan.Id
¦_
Account
Code of Merchant Account to which instance of this object is attributed to.
Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.

References: Payment Plan.Merchant Account Code
¦_
Create Date
Date when the record was created.

References: Payment Plan.Create Date
¦_
Type
Enumeration of possible types of payment plans.

References: Payment Plan.Payment Plan CL
¦_
Status
Represents current (or selected) status of the payment plan.

References: Payment Plan.Status CL
¦_
Billing Cycle
Reference to the entity that represents billing cycle associated with the payment plan.

References: Payment Plan.Billing Cycle FK
¦_
Renewal Amount
Renewal amount on the payment plan.

References: Payment Plan.Renewal Amount
¦_
Renewed Date
Renewed date of the payment plan.

References: Payment Plan.Renewed Date
¦_
Item
Reference to the entity that represents payment plan item that is applied as the basis for the billing processing.

References: Payment Plan.Item FK
¦_
change item
Allows to select a new item for the payment plan.
¦_
Tax
Tax charged on the payment plan's amount.

References: Payment Plan.Tax Amount
¦_
Seller Code
External identifier of the associated seller.
¦_
Parent Plan Code
Reference to the entity that represents code of the parent payment plan.

References: Payment Plan.Parent FK
¦_
Item Description
Short description of an item.

References: Payment Plan.Item Description
¦_
Change Item Description
Allows to add changes to the description of an associated item.
¦_
First Billing
Date when the first billing occured.

References: Payment Plan.First Billing Date
¦_
Next Processing Date
Date of the next payment processing.
¦_
Last Processing
Date when the last billing processing occured.

References: Payment Plan.Last Processing Date
¦_
Last Invoicing
Date when the last invoice was created.

References: Payment Plan.Last Invoicing Date
¦_
Last Update
Date when the payment plan was updated for the last time.

References: Payment Plan.Last Update Date
¦_
Amount
The amount of money charged every time billing occurs for this payment plan (e.g. amount of the transaction). Value must be submitted in cents without a decimal point.

References: Payment Plan.Amount
¦_
Length
Time period when the payment plan is active.

References: Payment Plan.Length
¦_
Value
Total value of the payment plan.

References: Payment Plan.Value
¦_
Deferred Length
Time period of the billing without invoice creation.

References: Payment Plan.Deferred Length
¦_
Deferred Value
Value of the billing without invoice creation.

References: Payment Plan.Deferred Value
¦_
Cancelled by
User that canceled the payment plan.
¦_
Cancellation Date
Date when the payment plan was cancelled.

References: Payment Plan.Cancellation Date

Payment Option

Includes payment information associated with a payment plan.
¦_
Account Number
Payment card number associated with the customer.
¦_
Name on Account
Name of the customer that the associated account belongs to.
¦_
Exp Date
Date when the card associated with an account will expire.
¦_
Street
Street of the customer's billing address.
¦_
City
City of the customer's billing address.
¦_
State
State of the customer's billing address. Consists of the two fields that allow to select a country and country's state.
¦_
ZIP
ZIP/Postal code of the customer's billing address.

Notes

Includes any additional notes associated with a payment plan.

Additional Info

Includes contract information associated with a payment plan.
¦_
Contract Effective Date
Date when the terms of the contract start.

References: Contract.Effective Date
¦_
Contract Expiration Date
Date when the terms of the contract end.

References: Contract.Expiration Date

Optional Groups

Includes information about the groups associated with a payment plan.
¦_
Group 1
Code of the optional group that includes any additional information that merchant needs.

References: Payment Plan.Ref Group Code1
¦_
Group 2
Code of the optional group that includes any additional information that merchant needs.

References: Payment Plan.Ref Group Code2
¦_
Group 3
Code of the optional group that includes any additional information that merchant needs.

References: Payment Plan.Ref Group Code3
¦_
Group 4
Code of the optional group that includes any additional information that merchant needs.

References: Payment Plan.Ref Group Code4
¦_
Group 5
Code of the optional group that includes any additional information that merchant needs.

References: Payment Plan.Ref Group Code5
¦_
Group 6
Code of the optional group that includes any additional information that merchant needs.

References: Payment Plan.Ref Group Code6

Charges

Includes information about the charges included in a payment plan.
¦_
Code
Identifier of the charge within an internal system.

References: Charge.Id
¦_
Create Date
Date when the record was created

References: Charge.Create Date
¦_
Type
References: Charge.Charge CL
¦_
Billing Date
Date when the charge is going to be included in the billing.
¦_
Is Prepaid
References: Charge.Is Prepaid
¦_
Freeze
Allows to freeze a payment plan.