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
Management API
Base Resource URL:
https://[server-name]
/api/
v01
/
customers
Description:
Provides access to customers registered within the system.
Available sub-resources:
Resource URL
Description
https://[server-name]
/api/v01/customers/
[customer-id]
Provides access to configuration settings for the specified customer.
Supported Actions:
create
Method:
PUT
Implicit:
Yes
Returns:
Customer
*
Consumes:
json, xml
Produces:
json, xml
Create customer records to establish billing profiles for your subscription services. A customer record serves as the foundation for recurring billing operations.\n\r\n> **Note:** Customer records include basic information such as the name and address, which connect to payment options and subscription plans.\n\r\n> **Warning:** Create customer records only if you intend to use the Recurring Billing API. Do not create Customers for non-recurring transactions processed through the Transaction API.\n\r\n> **Tip:** Customers can be associated with multiple payment methods and subscription plans, enabling the creation of flexible recurring billing models for your platform.
Parameters:
#
Name
Type
Required
Default
Description
01
object
Customer
*
Yes
Represents information about the customer.
find
Method:
GET
Implicit:
Yes
Returns:
Customer[]
*
Consumes:
xurl
Produces:
json, xml
Returns a list of available customers based on specified search criteria.
Parameters:
#
Name
Type
Required
Default
Description
01
offset
Integer
No
0
Index of the first record returned from the search result.\n\r\n> **Note:** Default value is 0. Used with limit parameter for pagination.\n\r\n> **Tip:** Use this field for implementing paginated results. See Error Messages section for details on pagination issues.
02
limit
Integer
No
100
Maximum number of records to load per search call.\n\r\n> **Note:** Default value is 100. Adjust based on performance requirements.\n\r\n> **Tip:** Use this field to balance response size and performance. See Webhooks Management Guide for details on handling large datasets.
03
accountId
Integer
No
Account ID used for filtering records.
04
firstName
String(125)
No
First name of the customer used for filtering Customer records.
05
lastName
String(125)
No
Last name of the customer used for filtering Customer records.
06
organizationName
String(255)
No
Name of the organization used for filtering Customer records.
07
email
String(100)
No
Email address of the customer used for filtering Customer records.
08
phone
String(15)
No
Phone number of the customer used for filtering Customer records.
09
street
String(128)
No
Street of the mailing address of the customer used for filtering Customer records.
10
city
String(50)
No
City of the mailing address of the customer used for filtering Customer records.
11
state
String(3)
No
State code of the mailing address of the customer used for filtering Customer records.
12
zipCode
String(10)
No
ZIP or postal code of the mailing address of the customer used for filtering Customer records.
13
countryCode
String(2)
No
Country code of the mailing address of the customer used for filtering Customer records.
