Documentation
for developers and administrators
Home
APIs
Processing
Billing
Management
Webhooks
Manuals
Terminology
User Guides
User Interface Reference
How-To Tutorials
Lessons
Data Dictionaries
UniCore
UniCharge
UniBill
Build
Properties Definition
Resources (Directory Structure)
Zip and Country Codes
Development
Log Files
Permissions
JNDI Names
Job Queues
Reference Materials
Supported Providers (Banks & Networks)
UniPay Codes & Code Mappings
Integrated 3rd Party Libraries
Diagrams and Documents
Entire website
This section only
Plan
UML
Added On:
06/05/18
SQL Table:
PLAN
Module:
UniBill
Type:
Entity
Status:
Active
Java Class:
Plan
Available Fields:
Amount
Billing Cycle Cl
Create Date
Id
Is Active
Merchant Account Code
Name
Ref Code
Tax Amount
Amount
Added On:
06/05/18
SQL Column:
AMOUNT
Java Field:
amount
Status:
Active
SQL Type:
int(11)
Java Type:
Integer
Attributes:
The amount of money charged every time billing occurs for this plan (e.g. amount of the transaction). Value must be submitted in cents without a decimal point.
Billing Cycle Cl
Added On:
06/05/18
SQL Column:
BILLING_CYCLE_CL
Java Field:
billingCycleCl
Status:
Active
SQL Type:
varchar(1)
Java Type:
String
References
Billing Cycle Classifier
Attributes:
Reference to the entity that represents billing cycle associated with the plan.
Create Date
Added On:
06/05/18
SQL Column:
CREATE_DATE
Java Field:
createDate
Status:
Active
SQL Type:
datetime
Java Type:
Date
Attributes:
Date when the record was created.
Id
Added On:
06/05/18
SQL Column:
ID
Java Field:
id
Status:
Active
SQL Type:
bigint(20)
Java Type:
Long
Identifier / Primary Key
Attributes:
Unique
Identifier of the object used for references; auto-incremented integer value.
Is Active
Added On:
06/05/18
SQL Column:
IS_ACTIVE
Java Field:
isActive
Status:
Active
SQL Type:
tinyint(1)
Java Type:
Boolean
Attributes:
Indicates whether a record is active within the system.
Merchant Account Code
Added On:
06/05/18
SQL Column:
MERCHANT_ACCOUNT_CODE
Java Field:
merchantAccountCode
Status:
Active
SQL Type:
int(11)
Java Type:
Integer
Attributes:
Required
Identifier of the account within the gateway.
Name
Added On:
06/05/18
SQL Column:
NAME
Java Field:
name
Status:
Active
SQL Type:
varchar(255)
Java Type:
String
Attributes:
Name of the plan.
Ref Code
Added On:
06/05/18
SQL Column:
REF_CODE
Java Field:
refCode
Status:
Active
SQL Type:
varchar(60)
Java Type:
String
Attributes:
See
Reference Field Type
definition for additional information.
Tax Amount
Added On:
05/13/23
SQL Column:
TAX_AMOUNT
Java Field:
taxAmount
Status:
Active
SQL Type:
int(11)
Java Type:
Integer
Attributes: